ホーム › System.WindowsSync › IChangeUnitListFilterInfo

IChangeUnitListFilterInfo

COM

IIDf2837671-0bdf-43fa-b502-232375fb50c2継承元ISyncFilterInfo自前メソッド開始 vtbl4

公式ドキュメント

ISyncChangeBatch オブジェクト内の項目について、どの変更単位 (change unit) を含めるかを制御するために使用できるフィルターを表します。

解説(Remarks)

プロバイダーが作成する変更バッチの内容をフィルター処理する場合、標準の変更バッチオブジェクトではなく、フィルター処理された ISyncChangeBatch オブジェクトを作成する必要があります。フィルター処理された変更バッチオブジェクトには、その変更バッチの内容がどのようにフィルター処理されたかを示す IChangeUnitListFilterInfo オブジェクトが含まれます。

メソッド 3

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

vtbl 4 HRESULT Initialize(BYTE** ppbChangeUnitIds, DWORD dwChangeUnitCount)

指定された変更単位 ID の配列を格納する IChangeUnitListFilterInfo クラスの新しいインスタンスを初期化します。

ppbChangeUnitIds	BYTE**	in	このフィルターに含める変更単位を示す、変更単位 ID の配列です。
dwChangeUnitCount	DWORD	in	ppbChangeUnitIds に格納されている変更単位 ID の数です。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	dwChangeUnitCount が 0 であるか、ppbChangeUnitIds に格納されている ID のいずれかが無効です。
E_OUTOFMEMORY
E_POINTER	ポインターが無効です。

解説(Remarks)

IChangeUnitListFilterInfo オブジェクトは再利用できます。Initialize を複数回呼び出すと、以前に格納されていた変更単位 ID の配列は解放され、ppbChangeUnitIds で指定された配列に置き換えられます。

vtbl 5 HRESULT GetChangeUnitIdCount(DWORD* pdwChangeUnitIdCount)

フィルターを定義する変更単位 ID の数を取得します。

pdwChangeUnitIdCount

DWORD*

inout

フィルターを定義する変更単位 ID の数を返します。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。

vtbl 6 HRESULT GetChangeUnitId(DWORD dwChangeUnitIdIndex, BYTE* pbChangeUnitId, DWORD* pcbIdSize)

フィルターを定義する変更単位 ID の配列内で、指定されたインデックスに格納されている変更単位 ID を取得します。

dwChangeUnitIdIndex	DWORD	in	検索する変更単位 ID のインデックスです。
pbChangeUnitId	BYTE*	inout	dwChangeUnitIdIndex で指定されたインデックスに格納されている変更単位 ID を返します。
pcbIdSize	DWORD*	inout	pbChangeUnitId のバイト数を指定します。pbChangeUnitId が小さすぎる場合は ID の取得に必要なバイト数を返し、そうでない場合は書き込まれたバイト数を返します。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	フィルターが定義されていないか、dwChangeUnitIdIndex がこのオブジェクトに格納されている変更単位 ID の数を超えています。
E_POINTER	ポインターが無効です。
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pbChangeUnitId が小さすぎます。この場合、必要なバイト数が pcbIdSize に返されます。
SYNC_E_ID_FORMAT_MISMATCH	返される変更単位 ID が無効です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IChangeUnitListFilterInfo "{F2837671-0BDF-43FA-B502-232375FB50C2}"
#usecom global IChangeUnitListFilterInfo IID_IChangeUnitListFilterInfo "{}"
#comfunc global IChangeUnitListFilterInfo_Initialize            4 var,int
#comfunc global IChangeUnitListFilterInfo_GetChangeUnitIdCount  5 var
#comfunc global IChangeUnitListFilterInfo_GetChangeUnitId       6 int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IChangeUnitListFilterInfo "{F2837671-0BDF-43FA-B502-232375FB50C2}"
#usecom global IChangeUnitListFilterInfo IID_IChangeUnitListFilterInfo "{}"
#comfunc global IChangeUnitListFilterInfo_Initialize            4 sptr,int
#comfunc global IChangeUnitListFilterInfo_GetChangeUnitIdCount  5 sptr
#comfunc global IChangeUnitListFilterInfo_GetChangeUnitId       6 int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。