Partilhar via


BCM_GETNOTE mensagem

Obtém o texto da anotação associada a um botão de link de comando. Você pode enviar essa mensagem explicitamente ou usar a macro Button_GetNote .

Parâmetros

wParam [in, out]

Um DWORD que especifica o tamanho do buffer apontado por lParam, em caracteres.

lParam [out]

O buffer de cadeia de caracteres para receber o texto. O buffer deve ser grande o suficiente para acomodar o caractere NULL de terminação.

Valor retornado

Se a mensagem for bem-sucedida, ela retornará TRUE. Caso contrário, retornará FALSE.

Comentários

A mensagem BCM_GETNOTE funciona apenas com botões que têm o estilo de botão BS_COMMANDLINK ou BS_DEFCOMMANDLINK .

GetLastError conterá:

  • ERROR_NOT_SUPPORTED, se o botão não tiver o estilo BS_DEFCOMMANDLINK ou BS_COMMANDLINK .
  • ERROR_INSUFFICIENT_BUFFER, se o buffer lParam for muito pequeno. O parâmetro wParam conterá o tamanho do buffer necessário, em caracteres.

Requisitos

Requisito Valor
Cliente mínimo com suporte
Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte
Windows Server 2008 [somente aplicativos da área de trabalho]
Cabeçalho
Commctrl.h

Confira também

Referência

Estilos de botão

Conceitual

Tipos de botão