ホーム › System.WindowsSync › ISyncChangeBatchAdvanced

ISyncChangeBatchAdvanced

COM

IID0f1a4995-cbc8-421d-b550-5d0bebf3e9a5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

変更のセットに関する追加情報を表します。

解説(Remarks)

ISyncChangeBatchAdvanced オブジェクトは、ISyncChangeBatch オブジェクトや ISyncFullEnumerationChangeBatch オブジェクトなどの変更バッチオブジェクトの QueryInterface メソッドに IID_ISyncChangeBatchAdvanced を渡すことで取得できます。

メソッド 4

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

vtbl 3 HRESULT GetFilterInfo(ISyncFilterInfo** ppFilterInfo)

変更バッチの作成時に指定された ISyncFilterInfo を取得します。

ppFilterInfo

ISyncFilterInfo**

out

変更バッチの作成時に指定された ISyncFilterInfo を返します。NULL は、変更バッチの作成時にフィルターが指定されなかったことを示します。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
S_FALSE	変更バッチの作成時にフィルターが指定されませんでした。この場合、ppFilterInfo には NULL が返されます。
E_POINTER	無効なポインターです。

vtbl 4 HRESULT ConvertFullEnumerationChangeBatchToRegularChangeBatch(ISyncChangeBatch** ppChangeBatch)

ISyncFullEnumerationChangeBatch オブジェクトを ISyncChangeBatch オブジェクトに変換します。

ppChangeBatch

ISyncChangeBatch**

out

この変更バッチオブジェクトを ISyncChangeBatch オブジェクトとして返します。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	無効なポインターです。
SYNC_E_INVALID_OPERATION	この変更バッチオブジェクトは ISyncFullEnumerationChangeBatch オブジェクトではありません。

vtbl 5 HRESULT GetUpperBoundItemId(BYTE* pbItemId, DWORD* pcbIdSize)

変更バッチ内のいずれかのグループのナレッジに含まれる、最大の項目 ID を取得します。

pbItemId	BYTE*	inout	変更バッチ内のいずれかのグループのナレッジに含まれる、最大の項目 ID を返します。
pcbIdSize	DWORD*	inout	pbItemId のバイト数を指定します。pbItemId が小さすぎる場合は ID の取得に必要なバイト数を返し、それ以外の場合は書き込まれたバイト数を返します。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	無効なポインターです。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pbItemId が小さすぎる場合です。この場合、必要なバイト数が pcbIdSize に返されます。

vtbl 6 HRESULT GetBatchLevelKnowledgeShouldBeApplied(BOOL* pfBatchKnowledgeShouldBeApplied)

バッチが宛先レプリカに適用された後、そのバッチの学習済みナレッジを保存する必要があるかどうかを示す値を取得します。

pfBatchKnowledgeShouldBeApplied

BOOL*

inout

バッチが宛先レプリカに適用された後、そのバッチの学習済みナレッジを保存する必要があるかどうかを示す値を返します。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	無効なポインターです。
SYNC_E_BATCH_NEEDS_KNOWLEDGE	変更バッチに変更もナレッジも含まれていません。

解説(Remarks)

通常、宛先プロバイダーは、各項目の変更が宛先レプリカに適用されるたびに、その変更の学習済みナレッジを保存します。GetBatchLevelKnowledgeShouldBeApplied が返す値は、変更バッチ全体が適用された後に、変更バッチの学習済みナレッジも保存する必要があるかどうかを示します。変更バッチの学習済みナレッジは、ISyncChangeBatchBase::GetLearnedKnowledge を呼び出すことで取得できます。

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