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

Описания RDS

Приложения

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

А.5. Сервисные функции и макросы RDS

А.5.2. Управление работой RDS и функции общего назначения

А.5.2.49. rdsShowHelp – вызов справки по файлу описания

# Приложения

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

### А.5. Сервисные функции и макросы RDS

#### А.5.2. Управление работой RDS и функции общего назначения

##### А.5.2.49. rdsShowHelp – вызов справки по файлу описания

Функция rdsShowHelp открывает справку из указанного файла описания справки по указанной теме.

      int RDSCALL rdsShowHelpA(
        RDSCSTR File,   // Имя файла описания справки или NULL (UTF8)
        RDSCSTR Topic,  // Имя темы в файле или NULL (UTF8)
        BOOL CheckOnly  // Не открывать справку, просто проверить ее наличие
      );
      int RDSCALL rdsShowHelpW(
        RDSWCSTR File,  // Имя файла описания справки или NULL (UTF16)
        RDSWCSTR Topic, // Имя темы в файле или NULL (UTF16)
        BOOL CheckOnly  // Не открывать справку, просто проверить ее наличие
      );
      // Функция-псевдоним
      int RDSCALL rdsShowHelp(
        RDSXCSTR File,  // Имя файла описания справки или NULL (кодировка по умолчанию)
        RDSXCSTR Topic, // Имя темы в файле или NULL (кодировка по умолчанию)
        BOOL CheckOnly  // Не открывать справку, просто проверить ее наличие
      );

Тип указателя на эту функцию

RDS_ISSB (для UTF8) или RDS_IWsWsB (для UTF16)

Параметры

File(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на строку с полным или сокращенным путем к файлу описания справки («.ui») или NULL для основной справки RDS. В сокращенном пути могут использоваться специальные символические константы RDS. Если имя файла указано без пути, будет считаться, что он располагается в стандартной папке с документацией и файлами справки RDS.
Topic(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на строку с именем темы в файле описания справки. Если в этом параметре передано значение NULL, будет открыта главная справка, указанная в файле описания.
CheckOnly(BOOL)
  TRUE – не открывать справку, а только проверить ее наличие и вернуть результат проверки. FALSE – открыть справку, если она существует.

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

Результат открытия справки (или проверки наличия, если в CheckOnly передано TRUE). Возвращается одна из следующих констант:

RDS_HELP_OK | Справка и тема существуют (и успешно открыты, если в CheckOnly передано FALSE).
RDS_HELP_NOUIFILE | Указанный в параметрах файл описания справки не найден.
RDS_HELP_READERROR | Ошибка чтения файла.
RDS_HELP_NOTOPIC | Указанная в параметрах тема не найдена в файле.
RDS_HELP_NOHELPFILE | Сам файл справки, указанный в файле описания для переданной в параметрах темы, отсутствует.
RDS_HELP_NOEXE | Для файла самой справки не найдена программа-обработчик, то есть указанный в файле описания файл справки нечем открыть.
RDS_HELP_UNKNOWN | Возникла какая-либо другая ошибка.

См. также

RDS_BFM_HELP, RDS_BFM_SHOWEXAMPLE, rdsShowHelpFile.