сообщение BCM_GETNOTE

Возвращает текст заметки, связанной с кнопкой командной ссылки. Это сообщение можно отправить явным образом или использовать макрос Button_GetNote .

Параметры

wParam [in, out]

Значение DWORD, указывающее размер буфера, на который указывает lParam, в символах.

lParam [out]

Строковый буфер для получения текста. Буфер должен быть достаточно большим, чтобы вместить завершающий символ NULL.

Возвращаемое значение

Если сообщение завершается успешно, возвращается значение TRUE. В противном случае возвращается значение FALSE.

Комментарии

Сообщение BCM_GETNOTE работает только с кнопками, которые имеют стиль BS_COMMANDLINK или BS_DEFCOMMANDLINK кнопки.

GetLastError будет содержать:

• ERROR_NOT_SUPPORTED, если кнопка не имеет стиля BS_DEFCOMMANDLINK или BS_COMMANDLINK .
• ERROR_INSUFFICIENT_BUFFER, если буфер lParam слишком мал. Параметр wParam будет содержать требуемый размер буфера в символах.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Заголовок	Commctrl.h

См. также раздел

Справочные материалы

Стили кнопок

Основные понятия

Типы кнопок