Win32 API 日本語リファレンス
ホームUI.Shell › ISearchBoxInfo

ISearchBoxInfo

COM
IID6af6e03f-d664-4ef4-9626-f7e0ed36755e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

検索ボックスに入力された情報を呼び出し元が取得できるメソッドを公開します。

解説(Remarks)

ここでは、検索ボックスが Windows エクスプローラーのウィンドウ フレーム内に表示されています。

Screen shot of upper-right corner of explorer frame showing search box 検索ボックスを含むフレームは、別のウィンドウや共通ファイル ダイアログ ボックスにホストされる場合もあります。

検索ダイアログにアクセスするには、Windows エクスプローラー ウィンドウ内のサイト ポインターに対して SID_SSearchBoxInfo を指定して QueryService を使用します。

実装が必要な場合

このインターフェイスの実装は Windows によって提供されます。サード パーティが独自のバージョンを実装する必要はありません。

メソッド 2

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

vtbl 3 HRESULT GetCondition(GUID* riid, void** ppv)

検索ボックスの内容を ICondition オブジェクトとして取得します。

riidGUID*inppv を通じて取得するインターフェイスの IID への参照です。通常は IID_ICondition です。
ppvvoid**outこのメソッドが正常に返された場合、riid で要求されたインターフェイス ポインターを格納します。通常は ICondition です。

戻り値

型: HRESULT

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

解説(Remarks)

ISearchBoxInfo::GetText が取得するテキスト文字列とは異なり、GetCondition は同じ情報を構造化オブジェクトとして取得します。このオブジェクトのメソッドを使用して、検索文字列を解析および操作できます。

Objbase.h で定義されている IID_PPV_ARGS マクロを使用して、riid パラメーターと ppv パラメーターをまとめることをお勧めします。このマクロは、ppv の値が指すインターフェイスに基づいて正しい IID を提供するため、riid のコーディング ミスによって予期しない結果が生じる可能性を排除できます。

vtbl 4 HRESULT GetText(LPWSTR* ppsz)

検索ボックスの内容をプレーン テキストとして取得します。

ppszLPWSTR*outこのメソッドが正常に返された場合に、検索ボックスに入力された全テキストを受け取るバッファーへのポインターです。

戻り値

型: 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_ISearchBoxInfo "{6AF6E03F-D664-4EF4-9626-F7E0ED36755E}"
#usecom global ISearchBoxInfo IID_ISearchBoxInfo "{}"
#comfunc global ISearchBoxInfo_GetCondition  3 var,sptr
#comfunc global ISearchBoxInfo_GetText       4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。