TreeView_GetISearchString マクロ (commctrl.h)

  • [アーティクル]

ツリー ビュー コントロールの増分検索文字列を取得します。 ツリー ビュー コントロールでは、増分検索文字列を使用して、ユーザーが入力した文字に基づいて項目を選択します。 このマクロを使用することも、TVM_GETISEARCHSTRING メッセージを明示的に送信することもできます。

構文

BOOL TreeView_GetISearchString(
   HWND   hwndTV,
   LPTSTR lpsz
);

パラメーター

hwndTV

型: HWND

ツリー ビュー コントロールへのハンドル。

lpsz

型: LPTSTR

増分検索文字列を受け取るバッファーへのポインター。

戻り値

型: BOOL

文字列が取得された場合 TRUE を返します。それ以外の場合は、FALSE します。

備考

セキュリティ警告: このマクロを誤って使用すると、プログラムのセキュリティが損なわれる可能性があります。 文字列を保持するのに十分な大きさのバッファーを割り当てる必要があります。 最初に、lpszで null 渡すマクロを呼び出します。 これにより、必要な文字数 (null除く) が返されます。 次に、マクロを 2 回目に呼び出して文字列を取得します。 続行する前に、「セキュリティに関する考慮事項: Microsoft Windows コントロールの」を確認する必要があります。

ツリー ビュー コントロールが増分検索モードでない場合、戻り値は 0 になります。

必要条件

要件 価値
サポートされる最小クライアント Windows Vista [デスクトップ アプリのみ]
サポートされる最小サーバー Windows Server 2003 [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー commctrl.h