Edit

Share via

IKnowledgeSyncProvider::BeginSession method (winsync.h)

  • Article

Notifies the provider that it is joining a synchronization session.

Syntax

HRESULT BeginSession(
  [in] SYNC_PROVIDER_ROLE role,
  [in] ISyncSessionState  *pSessionState
);

Parameters

[in] role

The role of this provider, relative to the other provider in the session.

[in] pSessionState

The current status of the corresponding session.

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

The provider must return an error if it cannot begin a session. This can occur when the provider has not been initialized, has an invalid configuration, or is already enlisted in an active 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 winsync.h

See also

IKnowledgeSyncProvider Interface