ISyncProviderRegistration::GetSyncProviderFromInstanceId method (syncregistration.h)

Article
02/22/2024

Returns an initialized and instantiated IRegisteredSyncProvider object for the specific unique instance ID.

Syntax

HRESULT GetSyncProviderFromInstanceId(
  [in]  LPCGUID                 pguidInstanceId,
  [in]  DWORD                   dwClsContext,
  [out] IRegisteredSyncProvider **ppSyncProvider
);

Parameters

[in] pguidInstanceId

The unique instance ID of the IRegisteredSyncProvider object.

[in] dwClsContext

The context in which the code that manages the newly created object will run. The only context supported is CLSCTX_INPROC_SERVER.

[out] ppSyncProvider

The initialized and instantiated synchronization provider 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.
E_INVALIDARG	The instance ID is GUID_NULL.
E_OUTOFMEMORY	There was not enough memory available to create the synchronization provider.
REGDB_E_CLASSNOTREG	The synchronization provider’s CLSID is not registered with the requested context or the provider has not had its DLL registered.
SYNC_E_REGISTRATION_NOTREGISTERED	A synchronization provider with the specified instance ID was not registered.

Remarks

Note The caller of this method should not explicitly call IRegisteredSyncProvider::Init on the IRegisteredSyncProvider object that is returned, as this method will do this on the caller's behalf. The caller should call QueryInterface on the IRegisteredSyncProvider object that is returned to obtain an ISyncProvider interface to pass to the synchronization session.

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

Share via