Edit

CfUpdateSyncProviderStatus function (cfapi.h)

  • Article

Updates the current status of the sync provider.

Syntax

HRESULT CfUpdateSyncProviderStatus(
  [in] CF_CONNECTION_KEY       ConnectionKey,
  [in] CF_SYNC_PROVIDER_STATUS ProviderStatus
);

Parameters

[in] ConnectionKey

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

[in] ProviderStatus

The current status of the sync provider. The status persists for the life of the sync root connection. The sync root connection is torn down either when CfDisconnectSyncRoot is called or if the sync provider process is terminated.

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 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

See also

CfDisconnectSyncRoot

CF_SYNC_PROVIDER_STATUS