ISyncProviderRegistration::GetSyncProviderState method (syncregistration.h)

  • Article

Returns the state of the specified synchronization provider.

Syntax

HRESULT GetSyncProviderState(
  [in]  LPCGUID pguidInstanceId,
  [out] DWORD   *pdwStateFlags
);

Parameters

[in] pguidInstanceId

The unique instance ID of the synchronization provider.

[out] pdwStateFlags

One of the following flags that represent the synchronization provider state.

  • SYNC_PROVIDER_STATE_ENABLED ((DWORD)0x00000001)The provider is enabled and available for synchronization.
  • SYNC_PROVIDER_STATE_DIRTY ((DWORD)0x00000002)The active provider has been updated and has new data to synchronize.

Return value

The possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
S_OK
 The method succeeded.
E_POINTER
 Invalid pointer.
SYNC_E_REGISTRATION_NOTREGISTERED
A synchronization provider with the specified instance ID was not registered.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header syncregistration.h

See also

ISyncProviderRegistration Interface