ISearchNotifyInlineSite
COM公式ドキュメント
Search サービスがカタログおよびインデックスの状態の更新を通知プロバイダーへ送信するために使用するメソッドを提供します。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
特定のドキュメントまたはアイテムの状態が変化したことをクライアントに通知するために、Search サービスから呼び出されます。
| sipStatus | SEARCH_INDEXING_PHASE | in | 送信される配列内の各ドキュメントの SEARCH_INDEXING_PHASE 状態です。 |
| dwNumEntries | DWORD | in | rgItemStatusEntries 内のエントリ数です。 |
| rgItemStatusEntries | SEARCH_ITEM_INDEXING_STATUS* | in | 状態更新情報を格納した SEARCH_ITEM_INDEXING_STATUS 構造体の配列です。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
カタログの状態が変化したことをクライアントに通知するために、Search サービスから呼び出されます。
| guidCatalogResetSignature | GUID* | in | カタログのリセットを表す GUID です。この GUID が変化した場合は、すべての通知を再送信する必要があります。 |
| guidCheckPointSignature | GUID* | in | 最後に復元されたチェックポイントを表す GUID です。この GUID が変化した場合は、最後に保存されたチェックポイント以降に蓄積されたすべての通知を再送信する必要があります。 |
| dwLastCheckPointNumber | DWORD | in | 最後に保存されたチェックポイントを示す番号です。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
カタログのチェックポイントが発生すると、Search サービスは dwLastCheckPointNumber を更新し、そのチェックポイントより前に送信されたすべての通知は、サービス障害が発生した場合でも安全に復旧できます。通知プロバイダーは、チェックポイント間で送信された通知のみを追跡すればよく、カタログが復元またはリセットされた場合にはそれらを再送信する必要があります。
カタログの復元が発生すると、Search サービスはカタログを最後に保存されたチェックポイントまでロールバックし、guidCheckPointSignature を更新します。この場合、通知プロバイダーは dwLastCheckPointNumber パラメーターで示される直近の保存済みチェックポイント以降に蓄積されたすべての通知を再送信する必要があります。
カタログのリセットが発生すると、Search サービスはカタログ全体をリセットし、guidCatalogResetSignature を更新します。通知プロバイダーは、クロールスコープ全体を再送信する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISearchNotifyInlineSite "{B5702E61-E75C-4B64-82A1-6CB4F832FCCF}" #usecom global ISearchNotifyInlineSite IID_ISearchNotifyInlineSite "{}" #comfunc global ISearchNotifyInlineSite_OnItemIndexedStatusChange 3 int,int,var #comfunc global ISearchNotifyInlineSite_OnCatalogStatusChange 4 var,var,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ISearchNotifyInlineSite "{B5702E61-E75C-4B64-82A1-6CB4F832FCCF}" #usecom global ISearchNotifyInlineSite IID_ISearchNotifyInlineSite "{}" #comfunc global ISearchNotifyInlineSite_OnItemIndexedStatusChange 3 int,int,sptr #comfunc global ISearchNotifyInlineSite_OnCatalogStatusChange 4 sptr,sptr,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。