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

ISearchPersistentItemsChangedSink

COM
📘 Microsoft Learn (日本語) · English
IIDa2ffdf9b-4758-4f84-b729-df81a1a0612f継承元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 を呼び出します。これにより、インデックス管理下の通知ソースは自身を「監視対象スコープ」のリストに追加できます。インデクサーは対応するドキュメントストアの増分クロールを開始します。インデクサーは、通知の欠落を引き起こした極端な状況が解消されるまで、これらのスコープを増分的にクロールします。このメソッドにより、通知が欠落していた期間にストア内で発生した変更が確実に検出されます。

通常の状況では、監視対象スコープのリストは使用されません。通知の欠落はまれであり、通常はディスク空き容量が極端に少ない場合にのみ発生します。

vtbl 4 HRESULT StoppedMonitoringScope(LPWSTR pszURL)

指定した階層スコープ内のアイテムに対する変更の監視をインデクサーに停止させるために、通知プロバイダーから呼び出されます。

pszURLLPWSTRin監視を停止するスコープのアドレスとなる、null で終わる Unicode 文字列へのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

ドキュメントストア内の変更の監視を担当する通知プロバイダーがオフラインになるとき、ISearchPersistentItemsChangedSink::StoppedMonitoringScope を呼び出して、通知ソースのリストからそのスコープを削除します。

vtbl 5 HRESULT OnItemsChanged(DWORD dwNumberOfChanges, SEARCH_ITEM_PERSISTENT_CHANGE* DataChangeEntries, HRESULT* hrCompletionCodes)

変更されたアイテムをインデックス化するようインデクサーに通知します。

dwNumberOfChangesDWORDin報告される変更の数。
DataChangeEntriesSEARCH_ITEM_PERSISTENT_CHANGE*in各変更の詳細を示す SEARCH_ITEM_PERSISTENT_CHANGE 型の構造体の配列。
hrCompletionCodesHRESULT*out各 URL がインデックス化のために受け入れられたかどうかを示します。

戻り値

型: HRESULT

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

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