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

ISearchProtocolThreadContext

COM
IIDc73106e1-ac80-11d1-8df3-00c04fb6ef4f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このオプションのインターフェイスにより、プロトコルハンドラーはプロトコルホスト内でフィルター処理に使用されるスレッド上でアクションを実行できます。

メソッド 3

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

vtbl 3 HRESULT ThreadInit()

プロトコルハンドラーとプロトコルホストとの間の通信を初期化します。

戻り値

型: HRESULT

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

解説(Remarks)

プロトコルホストによって作成されたスレッドは、プロトコルハンドラーとそのホストとの間の通信を初期化するために、プロトコルハンドラーに対してこのメソッドを呼び出します。プロトコルハンドラーによっては、ホストがスレッドごとのコンテキスト (たとえばログオンセッション) を提供する必要がある場合があります。

vtbl 4 HRESULT ThreadShutdown()

スレッドがシャットダウンされることをプロトコルハンドラーに通知します。

戻り値

型: HRESULT

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

解説(Remarks)

プロトコルホストはシャットダウンされる際、フィルター処理スレッドを終了する前の最後の操作としてこのメソッドを呼び出します。プロトコルハンドラーによっては、ログオンセッションなど、プロトコルハンドラーがクリーンアップする必要のあるスレッドごとのコンテキストが存在する場合があります。

vtbl 5 HRESULT ThreadIdle(DWORD dwTimeElaspedSinceLastCallInMS)

フィルター処理スレッドがアイドル状態であることをプロトコルハンドラーに通知し、プロトコルハンドラーが構築したキャッシュをクリーンアップできるようにします。

dwTimeElaspedSinceLastCallInMSDWORDinアイドル時間 (ミリ秒単位) をプロトコルハンドラーに渡します。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、フィルター処理スレッドがインデクサーサービスからの新しい要求を待機しているときに呼び出されます。プロトコルハンドラーはこのアイドル時間を利用してクリーンアップを行うことができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISearchProtocolThreadContext "{C73106E1-AC80-11D1-8DF3-00C04FB6EF4F}"
#usecom global ISearchProtocolThreadContext IID_ISearchProtocolThreadContext "{}"
#comfunc global ISearchProtocolThreadContext_ThreadInit      3
#comfunc global ISearchProtocolThreadContext_ThreadShutdown  4
#comfunc global ISearchProtocolThreadContext_ThreadIdle      5 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。