CButton::GetNote
Recupera o texto de anotação associado com o controle de link de comando corrente.
CString GetNote() const;
BOOL GetNote(
LPTSTR lpszNote,
UINT* cchNote
) const;
Parâmetros
Parâmetro |
Descrição |
|---|---|
[out] lpszNote |
Ponteiro para um buffer, que é responsável por alocando e desalocando o chamador.Se o valor retornado for true, o buffer contém o texto da nota que está associado com o controle de link de comando corrente; caso contrário, o buffer não é alterado. |
[in, out] cchNote |
Um ponteiro para uma variável de inteiro sem sinal. Quando esse método é chamado, a variável contém o dimensionar do buffer especificado pelo lpszNote parâmetro. Quando este método retorna, se o valor retornado é true a variável contém o dimensionar da nota associada ao controle de link de comando corrente. Se o valor retornado for false, a variável contém o dimensionar do buffer necessário para conter a anotação. |
Valor de retorno
A primeira sobrecarga, um CString objeto que contém o texto de anotação associado com o controle de link de comando corrente.
- ou -
Na segunda sobrecarga, true Se esse método for bem-sucedida; caso contrário, false.
Comentários
Use esse método somente com controles cujo estilo de botão é BS_COMMANDLINK ou BS_DEFCOMMANDLINK.
Esse método envia o BCM_GETNOTE mensagem, que é descrita no Windows SDK.
Requisitos
Cabeçalho: afxwin.h
Este método é suportado no Windows Vista e mais recente.
Requisitos adicionais para este método são descritos em compilação Requisitos para controles comuns do Windows Vista.