Текущий раздел:

Описания RDS

Приложения

Приложение А. Функции, константы и структуры RDS

А.2. События блока и связанные с ними описания

А.2.6. События пользовательского интерфейса и рисования внешнего вида блоков

А.2.6.6. RDS_BFM_HELP – вызов справки к блоку

# Приложения

## Приложение А. Функции, константы и структуры RDS

### А.2. События блока и связанные с ними описания

#### А.2.6. События пользовательского интерфейса и рисования внешнего вида блоков

##### А.2.6.6. RDS_BFM_HELP – вызов справки к блоку

Поток, в котором вызывается функция модели

Главный поток RDS.

Первый параметр функции модели (int CallMode)

Константа RDS_BFM_HELP.

Третий параметр функции модели (void *ExtParam)

Не используется (NULL).

Возвращаемое функцией модели значение

Любое ненулевое значение, если блок показал свою справку, ноль в противном случае.

Примечания

Реакция на событие RDS_BFM_HELP вызывается либо при выборе пункта «справка» контекстного меню блока, либо при нажатии клавиши F1 в тот момент, когда блок выделен. Реакция вызывается только у блоков, модели которых предварительно установили флаг RDS_BLOCKHASHELP в структурах данных. Реагируя на событие, модель должна показать пользователю справку к данному блоку (назначение, настройки, особенности присоединения и т.п.). Способ показа справки не регламентируется: модель может, например, воспользоваться сервисными функциями rdsShowHelp или rdsShowHelpFile. Модель может также открыть необходимый файл справки при помощи функций Windows API.

Возвращаемое моделью значение используется только при вызове справки клавишей F1. Если клавиша была нажата, и модель вернула ненулевое значение, никаких дополнительных действий не производится. Если же модель вернет ноль (справка к блоку не показана), будет показана обычная справка RDS.

См. также

RDS_BFM_SHOWEXAMPLE, rdsShowHelp, rdsShowHelpFile.