Edit

Share via

CfReportProviderProgress2 function (cfapi.h)

  • Article

Allows a sync provider to report progress out-of-band. Extends CfReportProviderProgress with additional parameters.

Syntax

HRESULT CfReportProviderProgress2(
  CF_CONNECTION_KEY ConnectionKey,
  CF_TRANSFER_KEY   TransferKey,
  CF_REQUEST_KEY    RequestKey,
  LARGE_INTEGER     ProviderProgressTotal,
  LARGE_INTEGER     ProviderProgressCompleted,
  DWORD             TargetSessionId
);

Parameters

ConnectionKey

A connection key representing a communication channel with the sync filter.

TransferKey

An opaque handle to the placeholder.

RequestKey

Allows the caller to report progress on a specific operation other than hydration.

ProviderProgressTotal

The total progress of the sync provider in response to a fetch data callback.

ProviderProgressCompleted

The completed progress of the sync provider in response to a fetch data callback.

TargetSessionId

Indicates the session at which this progress information is targeted.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 (10.0; Build 17763)
Header cfapi.h

See also

CfReportProviderProgress