Приложения

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

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

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

А.5.2.50. rdsShowHelpFile – вызов справки из конкретного файла

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

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

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

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

Параметры

File (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с полным или сокращенным путем к файлу справки одного из поддерживаемых RDS форматов. В сокращенном пути могут использоваться специальные символические константы RDS. Если имя файла указано без пути, будет считаться, что он располагается в стандартной папке с документацией и файлами справки RDS.
Topic (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с именем подтемы в файле справки, или NULL, если показ подтемы не требуется. Подтемы поддерживаются только для файлов HTML (показывается элемент со значением id="…", соответсвующим строке подтемы) и для схем RDS (строка подтемы должна содержать парметры командной строки запуска RDS).
CheckOnly (BOOL): TRUE – не открывать справку, а только проверить ее наличие и вернуть результат проверки. FALSE – открыть справку, если она существует.

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

Одна из констант RDS_HELP_*.

Примечания

Файл, указанный в параметре File, будет открыт программой, зарегистрирований в Windows для открытия файлов с данным расширением. Для расширений «.htm» и «.html» будет вызван стандартный браузер, для «.txt» – стандартный текстовый редактор, и т.п. Единственное исключение – файлы «.rds»: для них всегда вызывавется RDS, независимо от того, какая программа зарегистрирована в Windows для файлов с этим расширением.

См. также

RDS_BFM_HELP, RDS_BFM_SHOWEXAMPLE, rdsShowHelp.