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

ISearchManager2

COM
📘 Microsoft Learn (日本語) · English
IIDdbab3f73-db19-4a79-bfc0-a61a93886ddf継承元ISearchManager自前メソッド開始 vtbl16

公式ドキュメント

アプリケーションが Windows Search インデクサー内にカスタムカタログを作成および削除できるようにします。

解説(Remarks)

ISearchManager interface ref: ../searchapi/nn-searchapi-isearchmanager.md Managing the Index ref: /windows/win32/search/-search-3x-wds-mngidx-overview

この新機能は、新しい ISearchManager2 インターフェースを通じて公開されます。アプリケーションは、既存の ISearchManager インターフェースに対して QueryInterface を呼び出すことで、新しいインターフェースを取得できます。この機能が存在しない古いバージョンの Windows では、QueryInterface の呼び出しは失敗し、新しいインターフェースは返されません。既存の ISearchManager インターフェースは変更なしで使用できます。

エラーは、COM の標準的な方法に従って、各メソッドが返す HRESULT を通じて返されます。ISupportErrorInfo / IErrorInfo はサポートされません。例外はスローされません。

これらのメソッドは任意の COM アパートメントから呼び出すことができ、アパートメントの種類によって動作が影響を受けることはありません。これらの API は UI スレッドから呼び出しても安全ですが、プロセス間 I/O やその他の長時間実行される可能性のある処理を伴うため、推奨される方法ではありません。

メソッド 2

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

vtbl 16 HRESULT CreateCatalog(LPWSTR pszCatalog, ISearchCatalogManager** ppCatalogManager)

Windows Search インデクサー内に新しいカスタムカタログを作成し、その参照を返します。

pszCatalogLPWSTRin作成するカタログの名前。呼び出し元が任意に選択した名前を使用できますが、標準的な英数字とアンダースコアのみを含む必要があります。
ppCatalogManagerISearchCatalogManager**out成功した場合、作成されたカタログへの参照が ISearchCatalogManager インターフェースポインターとして返されます。呼び出し元のアプリケーションは、このインターフェースの使用を終えた後に Release() を呼び出す必要があります。

戻り値

型: HRESULT

操作の状態を示す HRESULT:

戻り値 説明
S_OK
 カタログは以前は存在せず、新たに作成されました。カタログへの参照が返されます。
S_FALSE
 カタログは以前から存在していました。カタログへの参照が返されます。

失敗を示す HRESULT: カタログの作成に失敗したか、無効な引数が渡されました。

解説(Remarks)

Windows Search インデクサー内に新しいカタログを作成するために呼び出します。 作成後は、返された ISearchCatalog マネージャーのメソッドを使用して、インデックスを作成する場所の追加、インデックス作成処理の監視、インデクサーに送信するクエリの構築と結果の取得を行えます。詳細については、「Managing the Index」を参照してください。

vtbl 17 HRESULT DeleteCatalog(LPWSTR pszCatalog)

既存のカタログと、それに関連付けられたすべてのインデックス済みデータを Windows Search インデクサーから削除します。

pszCatalogLPWSTRin削除するカタログの名前。そのカタログは、事前に CreateCatalog() の呼び出しによって作成されている必要があります。

戻り値

型: HRESULT

操作の状態を示す HRESULT:

戻り値 説明
S_OK
 カタログは以前から存在しており、正常に削除されました。
S_FALSE
 カタログは以前から存在しておらず、変更はありません。

失敗を示す 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_ISearchManager2 "{DBAB3F73-DB19-4A79-BFC0-A61A93886DDF}"
#usecom global ISearchManager2 IID_ISearchManager2 "{}"
#comfunc global ISearchManager2_CreateCatalog  16 wstr,sptr
#comfunc global ISearchManager2_DeleteCatalog  17 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。