ISyncSessionState2::SetProviderWithError method (winsync.h)

Article
10/13/2021

Indicates which provider caused synchronization to fail.

Syntax

HRESULT SetProviderWithError(
  [in] BOOL fSelf
);

Parameters

[in] fSelf

TRUE when the provider that calls this method is the provider that caused the error. Otherwise, FALSE.

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.
SYNC_E_INVALID_OPERATION	A synchronization session does not exist.

Remarks

The destination provider indicates which provider caused synchronization to fail during processing of the IKnowledgeSyncProvider::ProcessChangeBatch method, by using ISyncSessionState2::SetProviderWithError. ISyncSessionState2::SetProviderWithError is used by an application to obtain the ISyncProvider interface of the provider that caused the failure. The synchronization session 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

Share via