Прочитать на английском

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


Функция MLWinHelp

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

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

Синтаксис

BOOL MLWinHelp(
  _In_ HWND      hWndMain,
  _In_ LPCTSTR   lpszHelp,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData
);

Параметры

hWndMain [in]

Тип: HWND

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

lpszHelp [in]

Тип: LPCTSTR

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

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

uCommand [in]

Тип: UINT

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

dwData [in]

Тип: DWORD_PTR

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

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

Тип: BOOL

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

Замечания

Эта функция не включена в файл заголовка и должна вызываться порядковый номер 395 для MLWinHelpA и 397 для MLWinHelpW.

MLWinHelp по сути является оболочкой для WinHelp. Он пытается получить путь к файлу справки, соответствующему текущему параметру языка пользовательского интерфейса перед вызовом WinHelp. Если он успешно выполнен, он передает этот путь. Если он завершается ошибкой, он передает путь, указывающий на lpszHelp.

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

Перед закрытием окна, запрашивающего справку, приложение должно вызвать MLWinHelp с параметром 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.

 

Requirements

Требование Значение
Минимальная версия клиента
Windows 2000 Профессиональный, Windows XP [только классические приложения]
Минимальная версия сервера
Windows Server 2003 [только классические приложения]
Верхний колонтитул
нет
DLL-библиотеки
Shlwapi.dll (версия 5.0 или более поздняя версия)
Имена Юникода и ANSI
MLWinHelpW (Юникод) и MLWinHelpA (ANSI)

См. также

HELPWININFO

MULTIKEYHELP