ホーム › System.WindowsSync › IRequestFilteredSync

IRequestFilteredSync

COM

📘 Microsoft Learn (日本語) · English

IID2e020184-6d18-46a7-a32a-da4aeb06696c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

解説(Remarks)

通常、IRequestFilteredSync は宛先プロバイダーによって実装されます。

メソッド 1

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

vtbl 3 HRESULT SpecifyFilter(IFilterRequestCallback* pCallback)

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

pCallback

IFilterRequestCallback*

inoptional

変更列挙中にソースプロバイダーがフィルターを使用するように、宛先プロバイダーが要求するために使用するコールバックインターフェイス。

戻り値

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

戻り値	説明
S_OK	メソッドは成功しました。
プロバイダーが定めるエラーコード。

解説(Remarks)

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

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

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

注このメソッドの実装では、宛先プロバイダーとソースプロバイダーの両方がサポートするフィルターが見つかるまで、IFilterRequestCallback::RequestFilter を繰り返し呼び出すことができます。ソースプロバイダーは、ISupportFilteredSync::AddFilter の呼び出しに対して SYNC_E_FILTER_NOT_SUPPORTED を返すことで、そのフィルターをサポートしていないことを示します。

ISupportFilteredSync::AddFilter が SYNC_E_FILTER_NOT_SUPPORTED 以外のエラーを返した場合、IRequestFilteredSync::SpecifyFilter はそのエラーを同期アプリケーションに返す必要があります。これにより同期セッションは終了します。

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