Функция MLHtmlHelp

[Эта функция доступна в Windows XP и Windows Server 2003. Он может быть изменен или недоступен в последующих версиях Windows.]

Отображает окно справки, соответствующее текущему параметру языка пользовательского интерфейса.

Синтаксис

HWND MLHtmlHelp(
  _In_ HWND      hwndCaller,
  _In_ LPCTSTR   pszFile,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData,
  _In_ DWORD     dwCrossCodePage
);

Параметры

hwndCaller [in]

Тип: HWND

Дескриптор родительского окна, вызывающего эту функцию.

pszFile [in]

Тип: LPCTSTR

Указатель на буфер, содержащий полный путь к скомпилированному файлу справки (CHM) или файлу раздела в указанном файле справки.

uCommand [in]

Тип: UINT

Завершаемая команда. Эта функция напрямую поддерживает только HH_DISPLAY_TOPIC и HH_DISPLAY_TEXT_POPUP. В случае любой другой команды вызов перенаправится без значения dwCrossCodePage в HtmlHelp.

dwData [in]

Тип: DWORD_PTR

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

dwCrossCodePage [in]

Тип: DWORD

Значение DWORD , указывающее кодовую страницу текущего параметра языка пользовательского интерфейса, например CP_ACP.

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

Тип: HWND

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

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

Комментарии

Если возникает проблема с путем к файлу справки для текущего языка, вызов перенаправится в HtmlHelp для стандартной обработки.

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

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

Примеры

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

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

Примечание

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

 

Требования

Требование Значение
Минимальная версия клиента
Windows 2000 Professional, Windows XP [только классические приложения]
Минимальная версия сервера
Windows Server 2003 [только классические приложения]
Заголовок
Нет
DLL
Shlwapi.dll (версия 5.0 или более поздняя)
Имя в кодировке Юникод и ANSI
MLHtmlHelpW (Юникод) и MLHtmlHelpA (ANSI)