Compartilhar via


CButton::GetNote

Recupera o texto de nota associado ao controle de link de comando atual.

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

Parâmetros

Parâmetro

Descrição

[out] lpszNote

Ponteiro para um buffer, que este seja responsável para atribuir e desalocar.Se o valor de retorno é true, o buffer contém o texto de observe que está associado com o controle de link de comando atual; caso contrário, o buffer é inalterado.

Em, [out] cchNote

Um ponteiro para uma variável inteiros sem sinal.

Quando esse método é chamado, a variável contém o tamanho do buffer especificado pelo parâmetro de lpszNote .

Quando esse método retornar, se o valor de retorno é true a variável contém o tamanho de nota associada com o controle de link de comando atual.Se o valor de retorno é false, a variável contém o tamanho do buffer necessário para conter a observação.

Valor de retorno

Em a primeira sobrecarga, um objeto de CString que contém o texto de nota associado ao controle de link de comando atual.

-  ou  -

Em a segunda sobrecarga, true se este método é com êxito; caso contrário, false.

Comentários

Use este método somente com controles cujo estilo do botão é BS_COMMANDLINK ou BS_DEFCOMMANDLINK.

Este método envia a mensagem de BCM_GETNOTE , que é descrita em Windows SDK. 

Requisitos

Cabeçalho: afxwin.h

Este método é suportado em Windows Vista e posteriormente.

Os requisitos adicionais para o método são descritos em Criar requisitos de controles comuns do Windows Vista.

Consulte também

Referência

Classe de CButton

Gráfico de hierarquia

CButton::SetNote

CButton::GetNoteLength

BCM_GETNOTE