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

ISearchItemsChangedSink

COM
📘 Microsoft Learn (日本語) · English
IIDab310581-ac80-11d1-8df3-00c04fb6ef58継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

インデックスされた項目の変更に関する通知を提供します。また、変更された項目について監視している階層スコープの通知も提供します。

メソッド 3

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

vtbl 3 HRESULT StartedMonitoringScope(LPWSTR pszURL)

インデックスが管理する通知ソースが、自身を "監視対象スコープ" の一覧に追加できるようにします。

pszURLLPWSTRin監視スコープの開始アドレスとなる、null 終端の Unicode 文字列へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

通知エージェントがオンラインになると StartedMonitoringScope を呼び出し、そのスコープがソースの一覧に追加されます。ソースが新規の場合 (以前に StoppedMonitoringScope によって削除された場合や、そもそも作成されていなかった場合) は、インデクサーが対応するドキュメントストアの増分クロールを開始します。これは、通知エージェントがオフラインの間にストアで発生した変更を取得するためのものです。

vtbl 4 HRESULT StoppedMonitoringScope(LPWSTR pszURL)

実装されていません。(ISearchItemsChangedSink.StoppedMonitoringScope)

pszURLLPWSTRin監視スコープの開始アドレスを格納した、null 終端の Unicode 文字列へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT OnItemsChanged(DWORD dwNumberOfChanges, SEARCH_ITEM_CHANGE* rgDataChangeEntries, DWORD* rgdwDocIds, HRESULT* rghrCompletionCodes)

変更された項目を再インデックスするようインデクサーに通知するには、このメソッドを呼び出します。

dwNumberOfChangesDWORDin変更された項目の数。
rgDataChangeEntriesSEARCH_ITEM_CHANGE*in各項目に対する変更の種類と、そのパスまたは URL を示す SEARCH_ITEM_CHANGE 構造体の配列。
rgdwDocIdsDWORD*out変更された項目のドキュメント識別子の配列へのポインターを受け取ります。
rghrCompletionCodesHRESULT*out各項目がインデックス対象として受け入れられたかどうかを示す、rgdwDocIds に対応する完了コードの配列へのポインターを受け取ります。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

複数の変更通知がある場合、SEARCH_ITEM_CHANGE 構造体の priority メンバーが処理の優先順位を示します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISearchItemsChangedSink "{AB310581-AC80-11D1-8DF3-00C04FB6EF58}"
#usecom global ISearchItemsChangedSink IID_ISearchItemsChangedSink "{}"
#comfunc global ISearchItemsChangedSink_StartedMonitoringScope  3 wstr
#comfunc global ISearchItemsChangedSink_StoppedMonitoringScope  4 wstr
#comfunc global ISearchItemsChangedSink_OnItemsChanged          5 int,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。