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

ISyncFilterInfo2

COM
📘 Microsoft Learn (日本語) · English
IID19b394ba-e3d0-468c-934d-321968b2ab34継承元ISyncFilterInfo自前メソッド開始 vtbl4

公式ドキュメント

ISyncChangeBatch オブジェクトに含める変更を制御するために使用できるフィルターに関する追加情報を表します。

解説(Remarks)

ISyncFilterInfo2 は、ISyncFilterInfo オブジェクト、または IChangeUnitListFilterInfo オブジェクトのような ISyncFilterInfo から派生したオブジェクトに対して QueryInterface を呼び出すことで取得できます。

メソッド 1

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

vtbl 4 HRESULT GetFlags(DWORD* pdwFlags)

フィルター情報オブジェクトに関する追加情報を指定するフラグを取得します。

pdwFlagsDWORD*inoutフィルター情報オブジェクトに関する追加情報を指定するフラグを取得します。これは SYNC_FILTER_INFO_FLAG の値のいずれかになります (「解説」を参照してください)。

戻り値

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

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

解説(Remarks)

次の表は、ISyncFilterInfo オブジェクトに関する情報を指定するフラグについて説明します。

SYNC_FILTER_INFO_FLAG の値 説明
SYNC_FILTER_INFO_FLAG_ITEM_LIST このフラグは、同期される項目のセットが項目フィルターによって制限されていることを示します。
SYNC_FILTER_INFO_FLAG_CHANGE_UNIT_LIST IChangeUnitListFilterInfo オブジェクトは、変更がスコープに対して定義された変更単位のサブセットにのみ適用されることを指定します。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISyncFilterInfo2 "{19B394BA-E3D0-468C-934D-321968B2AB34}"
#usecom global ISyncFilterInfo2 IID_ISyncFilterInfo2 "{}"
#comfunc global ISyncFilterInfo2_GetFlags  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。