Compartir a través de


CButton::GetNote

Recupera el texto de la nota asociado al control de vínculo de comando actual.

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

Parámetros

Parámetro

Descripción

[out] lpszNote

Puntero a un búfer, que el llamador es responsable de asignar y desasignar. Si el valor devuelto es true, el búfer contiene el texto de la nota que está asociado al control de vínculo de comando actual; si no, el búfer no cambia.

[in, out] cchNote

un puntero a una variable de entero sin signo.

Cuando se llama a este método, la variable contiene el tamaño de búfer especificado por el parámetro de lpszNote .

Cuando este método vuelve, si el valor devuelto es true la variable contiene el tamaño de la nota asociado al control de vínculo de comando actual. Si el valor devuelto es false, la variable contiene el tamaño de búfer necesario para contener la nota.

Valor devuelto

En la primera sobrecarga, un objeto de CString que contiene el texto de la nota asociado al control de vínculo de comando actual.

O bien

En la segunda sobrecarga, true si este método es correcto; si no, false.

Comentarios

Utilice este método sólo con controles cuyo estilo de botón es BS_COMMANDLINK o BS_DEFCOMMANDLINK.

este método envía el mensaje de BCM_GETNOTE , que se describe en Windows SDK. 

Requisitos

encabezado: afxwin.h

Este método se admite en Windows Vista y posterior.

los requisitos adicionales para este método se describen en Requisitos de compilación para los controles comunes de Windows Vista.

Vea también

Referencia

CButton Class

Gráfico de jerarquías

CButton::SetNote

CButton::GetNoteLength

BCM_GETNOTE