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

Статья
11/20/2024

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

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

Синтаксис

HWND HtmlHelpA(
  [in, optional] HWND      hwndCaller,
  [in]           LPCSTR    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 указывает, что окно справки еще не создано.

Замечания

Синтаксис применяется к наборам символов ANSI. При использовании набора символов Юникода тип параметра pszFile должен быть "LPCTSTR".

При использовании API справки HTML задайте размер стека исполняемого файла размещения не менее 100k. Если определенный размер стека слишком мал, поток, созданный для запуска справки 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 или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
целевая платформа	Виндоус
заголовка	htmlhelp.h
библиотеки	Htmlhelp.lib
DLL	hhctrl.ocx

См. также

о API справки HTML

Поделиться через