ホーム › System.WindowsSync › ISupportFilteredSync

ISupportFilteredSync

COM

📘 Microsoft Learn (日本語) · English

IID3d128ded-d555-4e0d-bf4b-fb213a8a9302継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

派生クラスで実装された場合、フィルター処理された変更列挙をサポートし、使用するフィルターの種類をネゴシエートできるソースプロバイダーを表します。

解説(Remarks)

ISupportFilteredSync は通常、ソースプロバイダーによって実装されます。

メソッド 1

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

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

派生クラスで実装された場合、ソースプロバイダーが変更列挙に使用するフィルターを設定します。

pFilter	IUnknown*	inoptional	ソースプロバイダーが変更列挙に使用するフィルター。
filteringType	FILTERING_TYPE	in	フィルター処理された同期の際に変更バッチに含まれる情報の種類を示す FILTERING_TYPE 列挙値。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
SYNC_E_FILTER_NOT_SUPPORTED	pFilter で指定されたフィルターの種類がサポートされていない場合。
プロバイダーが定義するエラーコード。

解説(Remarks)

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

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

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

メモこのメソッドの実装では、pFilter および filteringType で指定されたフィルターを調べ、そのフィルターがサポートされていないことを示すために SYNC_E_FILTER_NOT_SUPPORTED を返すことができます。その場合、宛先プロバイダーはサポートされるフィルターが見つかるまで別のフィルターを要求できます。

通常、ISupportFilteredSync::AddFilter から SYNC_E_FILTER_NOT_SUPPORTED 以外のエラーが返された場合、宛先プロバイダーは同期セッションを終了します。

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