ホーム › System.WindowsSync › ISyncCallback

ISyncCallback

COM

IID0599797f-5ed9-485c-ae36-0c5d1bf2e7a5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

同期イベントをアプリケーションに通知するために使用される、アプリケーションのコールバックを表します。

メソッド 5

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

vtbl 3 HRESULT OnProgress(SYNC_PROVIDER_ROLE provider, SYNC_PROGRESS_STAGE syncStage, DWORD dwCompletedWork, DWORD dwTotalWork)

同期セッション中に定期的に発生し、進行状況を報告します。

provider	SYNC_PROVIDER_ROLE	in	このイベントに関連付けられたプロバイダーの役割。
syncStage	SYNC_PROGRESS_STAGE	in	同期セッションの現在の段階。
dwCompletedWork	DWORD	in	セッションで現在までに完了した作業量。この値は dwTotalWork の一部として解釈されます。
dwTotalWork	DWORD	in	セッションの作業量の合計。

戻り値

返される可能性があるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
アプリケーションが定義するエラーコード。

解説(Remarks)

OnProgress がいつ、どのような値で送信されるかは、プロバイダーによって異なります。

vtbl 4 HRESULT OnChange(ISyncChange* pSyncChange)

変更が適用される前に発生します。

pSyncChange

ISyncChange*

これから適用されるアイテムの変更。

戻り値

返される可能性があるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
アプリケーションが定義するエラーコード。

vtbl 5 HRESULT OnConflict(IChangeConflict* pConflict)

同時実行の競合解決ポリシーが CRP_NONE に設定されている場合に、競合が検出されたときに発生します。

pConflict

IChangeConflict*

競合に関する情報。競合している 2 つの変更のメタデータとアイテムデータが含まれます。

戻り値

返される可能性があるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
アプリケーションが定義するエラーコード。

解説(Remarks)

この通知は、同時実行の競合に対してアプリケーション独自の競合解決を行うために使用できます。そのためには、アプリケーションが pConflict の内容を調べて処理し、このメソッドから戻る前に IChangeConflict::SetResolveActionForChange を呼び出して競合に対する解決アクションを設定します。

vtbl 6 HRESULT OnFullEnumerationNeeded(SYNC_FULL_ENUMERATION_ACTION* pFullEnumerationAction)

ソースプロバイダーの forgotten knowledge (破棄済みナレッジ) が、宛先プロバイダーの現在のナレッジに含まれていない場合に発生します。

pFullEnumerationAction

SYNC_FULL_ENUMERATION_ACTION*

inout

同期セッションが完全列挙をどのように処理するかを指定します。

戻り値

返される可能性があるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
アプリケーションが定義するエラーコード。

解説(Remarks)

既定では、この通知を受け取るアプリケーションコールバックが登録されていない場合、Windows Sync は SFEA_ABORT を使用します。

vtbl 7 HRESULT OnRecoverableError(IRecoverableError* pRecoverableError)

同期プロバイダーがアイテムの読み込みまたは保存の際に回復可能なエラーを設定したときに発生します。

pRecoverableError

IRecoverableError*

回復可能なエラー。

戻り値

返される可能性があるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。
アプリケーションが定義するエラーコード。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISyncCallback "{0599797F-5ED9-485C-AE36-0C5D1BF2E7A5}"
#usecom global ISyncCallback IID_ISyncCallback "{}"
#comfunc global ISyncCallback_OnProgress               3 int,int,int,int
#comfunc global ISyncCallback_OnChange                 4 sptr
#comfunc global ISyncCallback_OnConflict               5 sptr
#comfunc global ISyncCallback_OnFullEnumerationNeeded  6 var
#comfunc global ISyncCallback_OnRecoverableError       7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ISyncCallback "{0599797F-5ED9-485C-AE36-0C5D1BF2E7A5}"
#usecom global ISyncCallback IID_ISyncCallback "{}"
#comfunc global ISyncCallback_OnProgress               3 int,int,int,int
#comfunc global ISyncCallback_OnChange                 4 sptr
#comfunc global ISyncCallback_OnConflict               5 sptr
#comfunc global ISyncCallback_OnFullEnumerationNeeded  6 sptr
#comfunc global ISyncCallback_OnRecoverableError       7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。