BCM_GETNOTE メッセージ

  • [アーティクル]

コマンド リンク ボタンに関連付けられているメモのテキストを取得します。 このメッセージは明示的に送信することも、 Button_GetNote マクロを使用することもできます。

パラメーター

wParam [in, out]

lParam が指すバッファーのサイズを文字で指定する DWORD。

lParam [out]

テキストを受信する文字列バッファー。 バッファーは、終端の NULL 文字に対応できる十分な大きさである必要があります。

戻り値

メッセージが成功すると、 TRUE が返されます。 それ以外の場合は FALSE を返します。

注釈

BCM_GETNOTE メッセージは、BS_COMMANDLINKまたはBS_DEFCOMMANDLINKボタン スタイルを持つボタンでのみ機能します。

GetLastError には次のものが含まれます。

  • ERROR_NOT_SUPPORTED、ボタンに BS_DEFCOMMANDLINK または BS_COMMANDLINK スタイルがない場合。
  • ERROR_INSUFFICIENT_BUFFER、 lParam バッファーが小さすぎる場合は 。 wParam パラメーターには、必要なバッファー サイズが文字で格納されます。

要件

要件 値
サポートされている最小のクライアント
 Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows Server 2008 [デスクトップ アプリのみ]
Header
Commctrl.h

関連項目

参照

ボタンのスタイル

概念

ボタンの種類