ISyncProviderRegistration::GetSyncProviderInfo method (syncregistration.h)

Article
02/22/2024

Returns an ISyncProviderInfo object for the specific synchronization provider instance ID.

Syntax

HRESULT GetSyncProviderInfo(
  [in]  LPCGUID           pguidInstanceId,
  [out] ISyncProviderInfo **ppProviderInfo
);

Parameters

[in] pguidInstanceId

The unique instance ID of the synchronization provider.

[out] ppProviderInfo

The synchronization provider information object.

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	The specified instance ID does not match a registered synchronization provider.

Remarks

By calling the GetSyncProvider method of the ISyncProviderInfo object that is returned by this method, you can get and set the properties of the synchronization provider, and obtain the synchronization provider's IRegisteredSyncProvider instance.

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