Функция WinHelpW (winuser.h)

Запускает справку Windows (Winhelp.exe) и передает дополнительные данные, указывающие на характер справки, запрошенной приложением.

Синтаксис

BOOL WinHelpW(
  HWND      hWndMain,
  LPCWSTR   lpszHelp,
  UINT      uCommand,
  ULONG_PTR dwData
);

Параметры

hWndMain

Тип: HWND

Дескриптор окна, запрашивающий справку. Функция WinHelp использует этот дескриптор для отслеживания того, какие приложения запрашивали справку. Если параметр uCommand указывает HELP_CONTEXTMENU или HELP_WM_HELP, hWndMain определяет справку по запросу элемента управления.

lpszHelp

Тип: LPCTSTR

Адрес строки, завершаемой значением NULL, содержащей путь, при необходимости, и имя файла справки, который WinHelp.

За именем файла можно следовать угловая скобка (>) и имя дополнительного окна, если раздел должен отображаться в дополнительном окне, а не в основном окне. Необходимо определить имя дополнительного окна в разделе [WINDOWS] файла проекта справки (HPJ).

uCommand

Тип: UINT

Тип запрошенной справки. Список возможных значений и их влияние на значение в параметре dwData см. в разделе "Примечания".

dwData

Тип: ULONG_PTR

Дополнительные данные. Используемое значение зависит от значения параметра uCommand. Список возможных значений dwData dwData см. в разделе "Примечания".

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

Тип: BOOL

Возвращает ненулевое значение в случае успешного выполнения или нуля. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Перед закрытием окна, запрашивающего справку, приложение должно вызвать WinHelp с параметром uCommand значение HELP_QUIT. До тех пор, пока все приложения не будут выполнены, справка Windows не завершит работу. Обратите внимание, что при вызове справки Windows с командой HELP_QUIT не требуется, если вы использовали команду HELP_CONTEXTPOPUP для запуска справки Windows.

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

В следующей таблице показаны возможные значения параметра uCommand и соответствующие форматы параметра dwData.

uCommand	Действие	dwData
HELP_COMMAND	Выполняет макрос справки или строку макроса.	Адрес строки, указывающей имя макросов справки для выполнения. Если строка задает несколько имен макросов, имена должны быть разделены точкой с запятой. Для некоторых макросов необходимо использовать короткую форму, так как справка Windows не поддерживает длинное имя.
HELP_CONTENTS	Отображает раздел, указанный параметром "Содержимое" в разделе [ПАРАМЕТРЫ] файла HPJ. Эта команда предназначена для обратной совместимости. Новые приложения должны предоставить CNT-файл и использовать команду HELP_FINDER.	Игнорировать; Установите значение 0.
HELP_CONTEXT	Отображает раздел, определяемый указанным идентификатором контекста, определенным в разделе [MAP] файла HPJ.	Содержит идентификатор контекста для раздела.
HELP_CONTEXTMENU	Отображает меню справки для выбранного окна, а затем отображает раздел выбранного элемента управления во всплывающем окне.	Адрес массива пар DWORD. Первый DWORD в каждой паре является идентификатором элемента управления, а второй — идентификатором контекста для раздела. Массив должен быть завершен парой нулей {0,0}. Если вы не хотите добавить справку в определенный элемент управления, задайте для его идентификатора контекста значение -1.
HELP_CONTEXTPOPUP	Отображает раздел, определенный указанным идентификатором контекста, определенным в разделе [MAP] файла HPJ во всплывающем окне.	Содержит идентификатор контекста для раздела.
HELP_FINDER	Отображает диалоговое окно "Разделы справки".	Игнорировать; Установите значение 0.
HELP_FORCEFILE	Гарантирует, что справка Windows отображает правильный файл справки. Если отображается неправильный файл справки, в справке Windows откроется правильный файл; в противном случае действие отсутствует.	Игнорировать; Установите значение 0.
HELP_HELPONHELP	Отображает справку по использованию справки Windows, если доступен файл Winhlp32.hlp.	Игнорировать; Установите значение 0.
HELP_INDEX	Отображает раздел, указанный параметром "Содержимое" в разделе [ПАРАМЕТРЫ] файла HPJ. Эта команда предназначена для обратной совместимости. Новые приложения должны использовать команду HELP_FINDER.	Игнорировать; Установите значение 0.
HELP_KEY	Отображает раздел в таблице ключевых слов, которая соответствует указанному ключевому слову, если имеется точное совпадение. Если имеется несколько совпадений, отображает индекс с разделами, перечисленными в списке темы, найденные.	Адрес строки ключевого слова. Несколько ключевых слов должны быть разделены точкой с запятой.
HELP_MULTIKEY	Отображает раздел, указанный ключевым словом в альтернативной таблице ключевых слов.	Адрес структуры MULTIKEYHELP, указывающей символ сноски таблицы и ключевое слово.
HELP_PARTIALKEY	Отображает раздел в таблице ключевых слов, которая соответствует указанному ключевому слову, если имеется точное совпадение. Если имеется несколько совпадений, отобразится диалоговое окно разделов, найденных. Чтобы отобразить индекс без передачи ключевого слова, используйте указатель на пустую строку.	Адрес строки ключевого слова. Несколько ключевых слов должны быть разделены точкой с запятой.
HELP_QUIT	Сообщает справке Windows о том, что она больше не нужна. Если другие приложения не попросили справку, Windows закрывает справку Windows.	Игнорировать; Установите значение 0.
HELP_SETCONTENTS	Указывает раздел "Содержимое". Справка Windows отображает этот раздел, когда пользователь нажимает кнопку содержимого , если файл справки не имеет связанного CNT-файла.	Содержит идентификатор контекста для раздела "Содержимое".
HELP_SETPOPUP_POS	Задает положение последующего всплывающего окна.	Содержит данные о положении. Используйте MAKELONG для объединения горизонтальных и вертикальных координат в одно значение. Всплывающее окно позиционируется так, как если бы курсор мыши находился в указанной точке при вызове всплывающего окна.
HELP_SETWINPOS	Отображает окно справки Windows, если оно свернуто или в памяти, и задает его размер и положение, как указано.	Адрес структуры HELPWININFO, указывающей размер и положение первичного или дополнительного окна справки.
HELP_TCARD	Указывает, что команда предназначена для экземпляра справки windows для карточки обучения. Объедините эту команду с другими командами с помощью побитового оператора OR.	Зависит от команды, с которой объединяется эта команда.
HELP_WM_HELP	Отображает раздел элемента управления, определяемого параметром hWndMain во всплывающем окне.	Адрес массива пар DWORD. Первый DWORD в каждой паре является идентификатором элемента управления, а второй — идентификатором контекста для раздела. Массив должен быть завершен парой нулей {0,0}. Если вы не хотите добавить справку в определенный элемент управления, задайте для его идентификатора контекста значение -1.

 

Заметка

Заголовок winuser.h определяет WinHelp как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h
библиотеки	User32.lib
DLL	User32.dll
набор API	ext-ms-win-ntuser-misc-l1-5-1 (представлено в Windows 10 версии 10.0.14393)

См. также

HELPWININFO

MULTIKEYHELP