Win32 API. Глобальные функции Windows
Страница 14.

Страница 14 из 14
 
WinHelp
BOOL WinHelp(HWND hWndMain, LPCTSTR lpszHelp, UINT uCommand, DWORD dwData);
Возвращаемое значение
Ненулевое, в случае успешного завершения функции, и нулевое в противном случае. Дополнительную информацию по ошибке можно получить, вызвав функцию GetLastError.
Аргументы
hWndMain - дескриптор окна, из которого вызывается справка. Функция WinHelp использует данный дескриптор для определения того, какое из приложений запросило справочную информацию. Если аргумент uCommand имеет значение HELP_CONTEXTMENU или HELP_WM_HELP, то данный аргумент определяет элемент управления, по которому нужно получить справку.
lpszHelp - указатель на заканчивающуюся нулем текстовую строку, содержащую имя и, если это необходимо, путь к файлу справки, текст которой данная функция должна выводить на экран. После имени файла может стоять угловая скобка (>) за которой указывается имя вторичного окна, если информация выводится во вторичное, а не в первичное окно справки. Имя вторичного окна справки должно быть определено в разделе [WINDOWS] файла проекта справки (.hpj).
uCommand - определяет тип запрашиваемой справочной информации.
dwData - дополнительная информация. Структура данного аргумента определяется значением аргумента uCommand.
Описание
Вызывает справочную систему Windows (Winhelp.exe) и передает ей дополнительную информацию, определяющую характер запрашиваемой справочной информации. Прежде, чем закрыть окно, запросившее справочную информацию необходимо вызвать функцию WinHelp и передать в аргументе uCommand команду HELP_QUIT. До того, как все приложения не произведут эту операцию справочная система Windows не может быть закрыта. В этой операции нет необходимости, если для вызова справки использовалась команда HELP_CONTEXTPOPUP. В таблице П2.2 указаны возможные значения аргумента uCommand, предпринимаемые при этом действия и соответствующий ему формат аргумента dwData.
Таблица П2.2. Соответствие значений агументов uCommand и dwData
Значения аргумента uCommand Предпринимаемые дейст-вия Формат аргумента dwData
HELP_COMMAND Выполняет макрос справки или строку макроса. Указатель на строку, содер-жащую имя выполняемого макроса справки. Если в строке указано несколько имен макросов, имена долж-ны разделяться точкой с запятой. Для некоторых макросов необходимо ис-пользовать короткую форму имени, поскольку справочная система Windows не позволя-ет работать с длинными именами.
HELP_CONTENTS Выводит содержимое раздела справки, определенное клю-чевым словом Contents в разделе [OPTIONS] файла .hpj. Эта команда использует-ся для обеспечения совмес-тимости с предыдущими версиями. Новые приложения должны использовать файл .cnt и команду HELP_FINDER. Игнорируется и устанавлива-ется в 0.
HELP_CONTEXT Выводит тему справки, за-данную контекстным иден-тификатором, определенным в разделе [MAP] файла .hpj. Целое число без знака, со-держащее контекстный иден-тификатор раздела.
HELP_CONTEXTMENU Выводит меню Help для указанного окна. Затем выво-дит справочную информацию по выделенному элементу управления во всплывающем окне. Указатель на массив пар идентификаторов. Первое двойное слово в каждой паре представляет собой иденти-фикатор элемента управле-ния, а второе слово - кон-текстный идентификатор раздела.
HELP_CONTEXTPOPUP Выводит во всплывающем окне тему справки, заданную контекстным идентификато-ром, определенным в разделе [MAP] файла .hpj. Целое число без знака, со-держащее контекстный иден-тификатор раздела.
HELP_FINDER Выводит диалоговое окно Справочная система. Игнорируется и устанавлива-ется в 0.
HELP_FORCEFILE Обеспечивает вывод требуе-мого файла справки справоч-ной системой. Если выводит-ся другой файл справки, справочная система выводит нужный. В противном случае не выполняет никаких дейст-вий. Игнорируется и устанавлива-ется в 0.
HELP_HELPONHELP Если доступен файл WINHLP32.HLP, выводит справочную информацию по пользованию справочной системой. Игнорируется и устанавлива-ется в 0.
HELP_INDEX Выводит содержимое раздела справки, определенное клю-чевым словом Contents в разделе [OPTIONS] файла .hpj. Эта команда использует-ся для обеспечения совмес-тимости с предыдущими версиями. Новые приложения должны использовать файл .cnt и команду HELP_FINDER. Игнорируется и устанавлива-ется в 0.
HELP_KEY Выводит тему справки по ключевому слову, содержа-щемуся в таблице ключевых слов в том случае, если обес-печено полное совпадение. Если найдено более одного раздела, соответствующего данному ключевому слову, выводит диалоговое окно Найденные разделы, содер-жащее список найденных разделов. Указатель на строку, содер-жащую ключевое слово. Несколько ключевых слов должны разделяться точкой с запятой.
HELP_MULTIKEY Выводит тему справки по ключевому слову, содержа-щемуся в альтернативной таблице ключевых слов. Указатель на объект структу-ры MULTIKEYHELP, опреде-ляющей символ нижнего индекса таблицы и ключевое слово.
HELP_PARTIALKEY Выводит тему справки по ключевому слову, содержа-щемуся в таблице ключевых слов в том случае, если обес-печено полное совпадение. Если найдено более одного раздела, соответствующего данному ключевому слову, выводит диалоговое окно Найденные разделы. Указатель на строку, содер-жащую ключевое слово. Несколько ключевых слов должны разделяться точкой с запятой. Для вывода содер-жания без указания ключево-го слова необходимо пере-дать указатель на пустую строку.
HELP_QUIT Сообщает справочной систе-ме Windows о прекращении работы с ней. Если со спра-вочной системой не работают другие приложения, закрыва-ет справочную систему Win-dows. Игнорируется и устанавлива-ется в 0.
HELP_SETCONTENTS Определяет содержимое раздела Contents. Справочная система Windows выводит эту тему, если файл справки не имеет связанного с ним файла .cnt. Целое число без знака, со-держащее контекстный иден-тификатор раздела Contents.
HELP_SETPOPUP_POS Устанавливает позицию всплывающего окна. Позиция всплывающего окна устанав-ливается таким образом, как будто бы указатель мыши располагался в указанной точке при вызове данного окна. Указатель на объект структу-ры POINT.
HELP_SETWINPOS Выводит окно справки, если оно было минимизировано или располагалось в памяти. Указатель на объект структу-ры HELPWININFO, опреде-ляющей размер и положение первичного или вторичного окна справки.
HELP_TCARD Указывает на то, что данная команда относится к после-довательности вторичных окон. Данная команда ком-бинируется с другими коман-дами с использованием опе-рации логического ИЛИ. Зависит от команды, с кото-рой объединена данная ко-манда.
HELP_WM_HELP Выводит во всплывающее окно справку об элементе управления, указанном в аргументе hWndMain. Указатель на массив пар идентификаторов. Первое двойное слово в каждой паре представляет собой иденти-фикатор элемента управле-ния, а второе слово - кон-текстный идентификатор раздела.

« Предыдущая страница - Следующая страница
 
« Предыдущая статья   Следующая статья »