ISyncProvider::GetIdParameters method (winsync.h)

Article
02/22/2024

Gets the ID format schema of the provider.

Syntax

HRESULT GetIdParameters(
  [out] ID_PARAMETERS *pIdParameters
);

Parameters

[out] pIdParameters

Returns the ID format schema of the provider.

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.
Provider-determined error codes.

Remarks

This method is used to get the ID format schema from the two providers that are participating in synchronization. A synchronization session should use this method to verify that the two providers have the same ID format schema, so that they can synchronize with one another.

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	winsync.h