Функция HtmlHelpW (htmlhelp.h)

Статья
08/12/2023

Отображает окно справки.

С помощью команд API можно указать, какой раздел будет отображаться в окне справки, является ли окно справки окном просмотра справки с тремя областями или всплывающим окном, а также следует ли обращаться к HTML-файлу раздела с помощью идентификатора контекста, URL-адреса справки HTML или поиска по ссылке на ключевое слово (KLink).

Синтаксис

HWND HtmlHelpW(
  [in, optional] HWND      hwndCaller,
  [in]           LPCWSTR   pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

Параметры

[in, optional] hwndCaller

Указывает дескриптор (hwnd) окна, вызывающего HtmlHelp. Окно справки принадлежит этому окну.

При закрытии окна справки HtmlHelp вернет фокус владельцу, если только владелец не является рабочим столом. Если hwndCaller является рабочим столом, операционная система определяет, куда возвращается фокус.

Кроме того, если HtmlHelp отправляет уведомления из окна справки, они отправляются в hwndCaller , если вы включили отслеживание сообщений уведомлений в определении окна справки.

[in] pszFile

В зависимости от значения uCommand указывает путь к скомпилированному файлу справки (CHM) или файлу раздела в указанном файле справки.

Можно также указать имя типа окна , которому предшествует символ больше (>).

Если для указанной команды файл не требуется, это значение может иметь значение NULL.

[in] uCommand

Указывает команду для выполнения.

[in] dwData

Указывает любые данные, которые могут потребоваться на основе значения параметра uCommand .

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

В зависимости от указанной команды uCommand и результата HtmlHelp возвращает одно или оба из следующих значений:

Дескриптор (hwnd) окна справки.
NULL. В некоторых случаях значение NULL указывает на сбой; в других случаях значение NULL указывает, что окно справки еще не создано.

При использовании API справки HTML задайте размер стека исполняемого файла размещения не менее 100 000 000. Если определенный размер стека слишком мал, поток, созданный для запуска справки HTML, также будет создан с этим размером стека, и может произойти сбой. При необходимости можно удалить /STACK из командной строки ссылки и удалить все параметры STACK в DEF-файле исполняемого файла (размер стека по умолчанию — 1 МБ). Вы также можете задать размер стека с помощью команды компилятора /Fnumber (компилятор передаст его компоновщику как /STACK).

Примеры

В следующем примере вызывается команда HH_DISPLAY_TOPIC , чтобы открыть файл справки с именем Help.chm и отобразить его раздел по умолчанию в окне справки с именем Mainwin. Как правило, окно справки, указанное в этой команде, является стандартным средством просмотра справки HTML.

HWND hwnd =
   HtmlHelp(
            GetDesktopWindow(),
            "c:\\Help.chm::/Intro.htm>Mainwin",
            HH_DISPLAY_TOPIC,
            NULL) ;

Примечание

Заголовок htmlhelp.h определяет HtmlHelp как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Целевая платформа	Windows
Header	htmlhelp.h
Библиотека	Htmlhelp.lib
DLL	hhctrl.ocx

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

Сведения об API справки HTML

Share via