現在のコマンド リンク コントロールに関連付けられている注釈テキストを取得します。
CString GetNote() const;
BOOL GetNote(
LPTSTR lpszNote,
UINT* cchNote
) const;
パラメーター
パラメーター |
説明 |
|---|---|
[出力] lpszNote |
バッファーへのポインター。このバッファーは、呼び出し元が割り当てて解放する必要があります。 戻り値が true の場合は、現在のコマンド リンク コントロールに関連付けられている注釈テキストがそのバッファーに入ります。それ以外の場合は、バッファーに変更はありません。 |
[入力、出力] cchNote |
符号なし整数変数へのポインター。 このメソッドが呼び出されると、lpszNote パラメーターで指定されているバッファーのサイズがその変数に入ります。 このメソッドの戻り値が true の場合は、現在のコマンド リンク コントロールに関連付けられている注釈のサイズがその変数に入ります。 戻り値が false の場合は、その注釈を入れるために必要なバッファーのサイズがその変数に入ります。 |
戻り値
1 番目のオーバーロードの場合は、現在のコマンド リンク コントロールに関連付けられている注釈テキストが入った CString オブジェクト。
または
2 番目のオーバーロードでは、このメソッドが成功した場合は true。それ以外の場合は false。
解説
このメソッドは、ボタン スタイルが BS_COMMANDLINK または BS_DEFCOMMANDLINK のコントロールでのみ使用します。
このメソッドは、BCM_GETNOTE メッセージを送信します。このメッセージについては、Windows SDK を参照してください。
必要条件
**ヘッダー:**afxwin.h
このメソッドは、Windows Vista およびそれ以降のバージョンでサポートされています。
このメソッドに関するその他の要件については、「Windows Vista コモン コントロールの作成要件」を参照してください。