CfReportProviderProgress function (cfapi.h)

Allows a sync provider to report progress out-of-band.

Syntax

HRESULT CfReportProviderProgress(
  [in] CF_CONNECTION_KEY ConnectionKey,
  [in] CF_TRANSFER_KEY   TransferKey,
  [in] LARGE_INTEGER     ProviderProgressTotal,
  [in] LARGE_INTEGER     ProviderProgressCompleted
);

Parameters

[in] ConnectionKey

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

[in] TransferKey

An opaque handle to the placeholder.

[in] ProviderProgressTotal

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

[in] ProviderProgressCompleted

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

Return value

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

Requirements

   
Minimum supported client Windows 10, version 1709 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header cfapi.h
Library CldApi.lib
DLL CldApi.dll