CButton::GetNote

检索批注文本与当前命令链接控件。

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

参数

Parameter

说明

[out] lpszNote

对缓冲区的指针,调用方负责分配和释放。 如果返回值为 true,缓冲区包含与当前命令链接控件的说明文本;否则,缓冲区保持不变。

[in,out] cchNote

为无符号整数变量的指针。

当调用此方法时,该变量包含 lpszNote 参数指定的缓冲区的大小。

当此方法返回时,则为;返回值是 true 该变量包含说明的大小与当前命令链接控件。 如果返回值为 false,该变量包含请求的缓冲区大小包含说明。

返回值

在第一个重载,包含的 CString 对象说明文本与当前命令链接控件。

- 或 -

在第二个重载,true,则此方法成功;否则,false。

备注

使用此方法仅使用按钮样式是 BS_COMMANDLINK 或 BS_DEFCOMMANDLINK的控件。

此方法发送 BCM_GETNOTE 信息,在 Windows SDK所述。 

要求

标头: afxwin.h

此方法在 Windows Vista 和更高版本支持。

此方法的其他要求。Windows vista公共控件的生成要求所述。

请参见

参考

CButton选件类

层次结构图

CButton::SetNote

CButton::GetNoteLength

BCM_GETNOTE