ホーム › System.WindowsSync › IFilterRequestCallback

IFilterRequestCallback

COM

📘 Microsoft Learn (日本語) · English

IID82df8873-6360-463a-a8a1-ede5e1a1594d継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

宛先プロバイダーとソースプロバイダーの間でフィルターのネゴシエーションを仲介します。

メソッド 1

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

vtbl 3 HRESULT RequestFilter(IUnknown* pFilter, FILTERING_TYPE filteringType)

宛先プロバイダーによって指定されたフィルターを、変更列挙中にソースプロバイダーが使用するように要求します。

pFilter	IUnknown*	inoptional	宛先プロバイダーによって指定されたフィルター。このフィルターは、変更列挙中に使用されるようにソースプロバイダーへ渡されます。
filteringType	FILTERING_TYPE	in	フィルター処理された同期の際に、変更バッチに含まれる情報の種類を示す FILTERING_TYPE 列挙値。

戻り値

戻り値として考えられるコードには、次の表に示す値が含まれます (ただし、これらに限定されません)。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	ポインターが無効です。
SYNC_E_FILTER_NOT_SUPPPORTED	pFilter で指定されたフィルターがソースプロバイダーでサポートされていない場合に返されます。また、ソースプロバイダーが ISupportFilteredSync を実装していない場合にも返されます。

解説(Remarks)

フィルターのネゴシエーションは、次の手順で行われます。

ソースプロバイダーが変更の列挙を開始する前に、宛先プロバイダーの IRequestFilteredSync::SpecifyFilter を呼び出してフィルターのネゴシエーションを開始します。
IRequestFilteredSync::SpecifyFilter の処理中に、宛先プロバイダーは IFilterRequestCallback::RequestFilter にフィルターを渡します。
IFilterRequestCallback::RequestFilter の処理中に、ソースプロバイダーの ISupportFilteredSync::AddFilter を呼び出します。ソースプロバイダーが要求されたフィルターをサポートしていない場合、宛先プロバイダーはサポートされるフィルターが見つかるまでフィルターの要求を続けることができます。

フィルターのネゴシエーションが成功すると、ソースプロバイダーはそのフィルターを使用して、変更列挙中に含める項目を決定します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFilterRequestCallback "{82DF8873-6360-463A-A8A1-EDE5E1A1594D}"
#usecom global IFilterRequestCallback IID_IFilterRequestCallback "{}"
#comfunc global IFilterRequestCallback_RequestFilter  3 sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。