Win32 API 日本語リファレンス
ホーム › Storage.OfflineFiles › IOfflineFilesEventsFilter

IOfflineFilesEventsFilter

COM
📘 Microsoft Learn (日本語) · English
IID33fc4e1b-0716-40fa-ba65-6e62a84a846f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

発行されたイベントの受信側が、受け取るイベントインスタンスの数を制限するための仕組みを提供します。

メソッド 3

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

vtbl 3 HRESULT GetPathFilter(LPWSTR* ppszFilter, OFFLINEFILES_PATHFILTER_MATCH* pMatch)

このイベントシンクに配信すべきパスベースのイベントを示す UNC パス文字列とスコープ指示子を取得します。

ppszFilterLPWSTR*outフィルターに関連付けられたパスを識別する完全修飾 UNC パス文字列を受け取ります。この文字列のメモリは CoTaskMemAlloc 関数を使用して割り当てる必要があります。
pMatchOFFLINEFILES_PATHFILTER_MATCH*outイベントシンクに配信されるイベントの集合に、フィルターパスのどの子孫を含めるかを示す OFFLINEFILES_PATHFILTER_MATCH 列挙値を受け取ります。

戻り値

実装されている場合は S_OK、実装されていない場合は E_NOTIMPL を返します。

vtbl 4 HRESULT GetIncludedEvents(DWORD cElements, OFFLINEFILES_EVENTS* prgEvents, DWORD* pcEvents)

イベントシンクが受け取るべきイベントを示す OFFLINEFILES_EVENTS 列挙値の配列を取得します。

cElementsDWORDinprgEvents パラメーターが参照する配列に格納できる要素の最大数を指定します。
prgEventsOFFLINEFILES_EVENTS*outOFFLINEFILES_EVENTS 列挙値の配列のアドレスを格納します。対応するイベントをこのイベントシンクが必要とすることを指定するには、配列の要素に OFFLINEFILES_EVENT_XXXXXX 識別子を設定します。
pcEventsDWORD*outprgEvents パラメーターが参照する配列に実際に書き込まれた要素の数を受け取ります。

戻り値

実装されている場合は S_OK、実装されていない場合は E_NOTIMPL を返します。

vtbl 5 HRESULT GetExcludedEvents(DWORD cElements, OFFLINEFILES_EVENTS* prgEvents, DWORD* pcEvents)

イベントシンクが受け取るべきでないイベントを示す OFFLINEFILES_EVENTS 列挙値の配列を取得します。

cElementsDWORDinprgEvents パラメーターが参照する配列に格納できる要素の最大数を指定します。
prgEventsOFFLINEFILES_EVENTS*outOFFLINEFILES_EVENTS 列挙値の配列のアドレスを格納します。対応するイベントをこのイベントシンクが必要としないことを指定するには、配列の要素に OFFLINEFILES_EVENT_XXXXXX 識別子を設定します。
pcEventsDWORD*outprgEvents パラメーターが参照する配列に実際に書き込まれた要素の数を受け取ります。

戻り値

実装されている場合は S_OK、実装されていない場合は E_NOTIMPL を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOfflineFilesEventsFilter "{33FC4E1B-0716-40FA-BA65-6E62A84A846F}"
#usecom global IOfflineFilesEventsFilter IID_IOfflineFilesEventsFilter "{}"
#comfunc global IOfflineFilesEventsFilter_GetPathFilter      3 var,var
#comfunc global IOfflineFilesEventsFilter_GetIncludedEvents  4 int,var,var
#comfunc global IOfflineFilesEventsFilter_GetExcludedEvents  5 int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。