CButton::GetNote

更新 : 2007 年 11 月

現在のコマンドリンクコントロールに関連付けられている注釈テキストを取得します。

CString GetNote() const;
BOOL GetNote(
          LPTSTR lpszNote, 
          UINT* cchNote
) const;

パラメータ

パラメータ	説明
[出力] lpszNote	バッファへのポインタ。このバッファは、呼び出し元が割り当てて解放する必要があります。戻り値が true の場合は、現在のコマンドリンクコントロールに関連付けられている注釈テキストがそのバッファに入ります。それ以外の場合は、バッファに変更はありません。
[入力、出力] cchNote	符号なし整数変数へのポインタ。このメソッドが呼び出されると、lpszNote パラメータで指定されているバッファのサイズがその変数に入ります。このメソッドの戻り値が true の場合は、現在のコマンドリンクコントロールに関連付けられている注釈のサイズがその変数に入ります。戻り値が false の場合は、その注釈を入れるために必要なバッファのサイズがその変数に入ります。

[出力] lpszNote

バッファへのポインタ。このバッファは、呼び出し元が割り当てて解放する必要があります。戻り値が true の場合は、現在のコマンドリンクコントロールに関連付けられている注釈テキストがそのバッファに入ります。それ以外の場合は、バッファに変更はありません。

[入力、出力] cchNote

符号なし整数変数へのポインタ。

このメソッドが呼び出されると、lpszNote パラメータで指定されているバッファのサイズがその変数に入ります。

このメソッドの戻り値が true の場合は、現在のコマンドリンクコントロールに関連付けられている注釈のサイズがその変数に入ります。戻り値が false の場合は、その注釈を入れるために必要なバッファのサイズがその変数に入ります。