IKnowledgeSyncProvider::EndSession method (winsync.h)

  • Article

Notifies the provider that a synchronization session to which it was enlisted has finished.

Syntax

HRESULT EndSession(
  [in] ISyncSessionState *pSessionState
);

Parameters

[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

pSessionState will be equal to the ISyncSessionState object that was provided to the previous corresponding call to IKnowledgeSyncProvider::BeginSession.

Note  This method must return an error, typically SYNC_E_INVALIDOPERATION, if the provider did not receive a previous call to BeginSession for the specified session.

When this method is called, the provider must release any references it has to the ISyncSessionState object that is specified by pSessionState.

 

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