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

  • Статья

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

Синтаксис

BOOL WinHelpA(
  HWND      hWndMain,
  LPCSTR    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 см. в разделе Примечания.

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

Тип: 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 отображается правильный файл справки. Если отображается неправильный файл справки, откроется правильный. в противном случае действие не выполняется. Игнорировать; Для задано значение 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 или Юникод этой функции на основе определения константы препроцессора UNICODE. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

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

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

HELPWININFO

MULTIKEYHELP