CfQuerySyncProviderStatus function (cfapi.h)

Queries a sync provider to get the status of the provider.

Syntax

HRESULT CfQuerySyncProviderStatus(
  [in]  CF_CONNECTION_KEY       ConnectionKey,
  [out] CF_SYNC_PROVIDER_STATUS *ProviderStatus
);

Parameters

[in] ConnectionKey

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

[out] ProviderStatus

The current status of the sync provider.

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

CF_SYNC_PROVIDER_STATUS