ISyncSessionExtendedErrorInfo::GetSyncProviderWithError method (winsync.h)

Gets the ISyncProvider interface of the provider that caused synchronization to fail.

Syntax

HRESULT GetSyncProviderWithError(
  [out] ISyncProvider **ppProviderWithError
);

Parameters

[out] ppProviderWithError

The ISyncProvider interface of the provider that caused synchronization to fail.

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_INVALID_OPERATION
A synchronization session was not started.

Remarks

The destination provider indicates which provider caused synchronization to fail during processing of the IKnowledgeSyncProvider::ProcessChangeBatch method by using ISyncSessionState2::SetProviderWithError. ISyncSessionExtendedErrorInfo::GetSyncProviderWithError is used by an application to obtain the ISyncProvider interface of the provider that caused the failure. The application can then query for other interfaces that are implemented by the provider, and call methods to handle the error.

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

See also

IKnowledgeSyncProvider Interface

ISyncProvider Interface

ISyncSessionExtendedErrorInfo Interface

ISyncSessionState2 Interface