Win32 API 日本語リファレンス
ホームSystem.WindowsSync › ISyncSessionState2

ISyncSessionState2

COM
IID9e37cfa3-9e38-4c61-9ca3-ffe810b45ca2継承元ISyncSessionState自前メソッド開始 vtbl10

公式ドキュメント

現在の同期セッションに関する追加情報を表します。

解説(Remarks)

ISyncSessionState2 オブジェクトは、ISyncSessionState オブジェクトの QueryInterface メソッドに IID_ISyncSessionState2 を渡すことで取得できます。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 10 HRESULT SetProviderWithError(BOOL fSelf)

同期の失敗を引き起こしたプロバイダーを示します。

fSelfBOOLinこのメソッドを呼び出すプロバイダーがエラーの原因となったプロバイダーである場合は TRUE。それ以外の場合は FALSE

戻り値

戻り値には、次の表に示す値が含まれますが、これらに限定されるものではありません。

戻り値 説明
S_OK
メソッドは成功しました。
SYNC_E_INVALID_OPERATION
同期セッションが存在しません。

解説(Remarks)

コピー先プロバイダーは、IKnowledgeSyncProvider::ProcessChangeBatch メソッドの処理中に同期の失敗を引き起こしたプロバイダーを、ISyncSessionState2::SetProviderWithError を使用して示します。ISyncSessionState2::SetProviderWithError は、失敗の原因となったプロバイダーの ISyncProvider インターフェイスを取得するために、アプリケーションによって使用されます。同期セッションは、その後、そのプロバイダーが実装している他のインターフェイスをクエリし、エラーを処理するメソッドを呼び出すことができます。

vtbl 11 HRESULT GetSessionErrorStatus(HRESULT* phrSessionError)

同期セッションが失敗した理由を示すエラー値を取得します。

phrSessionErrorHRESULT*inout同期セッションが失敗した理由を示すエラー値。

戻り値

戻り値には、次の表に示す値が含まれますが、これらに限定されるものではありません。

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
無効なポインターです。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_ISyncSessionState2 "{9E37CFA3-9E38-4C61-9CA3-FFE810B45CA2}"
#usecom global ISyncSessionState2 IID_ISyncSessionState2 "{}"
#comfunc global ISyncSessionState2_SetProviderWithError   10 int
#comfunc global ISyncSessionState2_GetSessionErrorStatus  11 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。