структура HH_AKLINK (htmlhelp.h)

Используйте эту структуру, чтобы указать одно или несколько имен ALink или ключевых слов KLink, которые требуется найти.

Синтаксис

typedef struct tagHH_AKLINK {
  int     cbStruct;
  BOOL    fReserved;
  LPCTSTR pszKeywords;
  LPCTSTR pszUrl;
  LPCTSTR pszMsgText;
  LPCTSTR pszMsgTitle;
  LPCTSTR pszWindow;
  BOOL    fIndexOnFail;
} HH_AKLINK;

Члены

cbStruct

Задает размер структуры. Это значение всегда должно быть заполнено перед передачей структуры в API справки HTML.

fReserved

Этот параметр должен иметь значение FALSE.

pszKeywords

Указывает одно или несколько имен ALink или ключевых слов KLink для поиска. Несколько записей разделяются точкой с запятой.

pszUrl

Указывает файл раздела для перехода в случае сбоя поиска. PszURL ссылается на допустимый раздел в указанном скомпилированном файле справки (CHM) и не поддерживает протоколы Интернета, указывающие на HTML-файл.

pszMsgText

Указывает текст, отображаемый в окне сообщения, если поиск завершается ошибкой, а fIndexOnFail имеет значение FALSE, а pszURL — NULL.

pszMsgTitle

Указывает подпись окна сообщения, в котором отображается параметр pszMsgText.

pszWindow

Указывает имя типа окна, в котором будет отображаться одно из следующих элементов:

  • Выбранный раздел, если поиск дает один или несколько совпадающих тем.
  • Раздел, указанный в pszURL, если поиск завершается сбоем и тема указана в pszURL.
Вкладка Индекс, если поиск завершается сбоем и параметр fIndexOnFail имеет значение TRUE.

fIndexOnFail

Указывает, следует ли отображать ключевое слово на вкладке Индекс средства справки HTML в случае сбоя поиска. Значение pszWindow указывает средство просмотра справки.

Комментарии

  • Подстановки имени ALink и KLink ключевое слово учитывается регистр, а несколько ключевых слов разделяются точкой с запятой.
  • Если поиск дает один или несколько совпадающих тем, заголовки тем отображаются в диалоговом окне Найденные темы.
Если при поиске нет совпадающих тем, HtmlHelp() проверяет значения следующих членов HH_AKLINK , чтобы определить, какое альтернативное действие следует предпринять:
  • fIndexOnFail. Если параметр fIndexOnFail имеет значение TRUE, в окне справки, указанном в pszWindow, выбирается вкладка Индекс, а в поле записи выбирается ключевое слово, указанный в pszKeyword.
  • pszURL. Если параметр fIndexOnFail имеет значение FALSE, файл раздела, указанный в pszURL , отображается в окне справки, указанном в pszWindow.
  • pszMsgText и pszMsgTitle. Если fIndexOnFail имеет значение FALSE, а pszURL — NULL, появится окно сообщения с текстом и подпись, указанными в pszMsgText и pszMsgTitle.

Используется

Требования

Требование Значение
Заголовок htmlhelp.h

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

Сведения о структурах

  • Last updated on