|
| БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО! |
|
|
WinHelp
The WinHelp function starts Windows Help (WINHELP.EXE) and passes additional data indicating the nature of the help requested by the application. The application specifies the name and, where required, the directory path of the help file to display.
BOOL WinHelp(
HWND hWndMain, // handle of window requesting Help LPCTSTR lpszHelp, // address of directory-path string UINT uCommand, // type of Help DWORD dwData // additional data );
Parameters
hWndMain
Identifies the window requesting Help. The WinHelp function uses this handle to keep track of which applications have requested Help.
lpszHelp
Points to a null-terminated string containing the path, if necessary, and the name of the Help file that the Help application is to display. The filename may be followed by an angle bracket (>) and the name of a secondary window if the topic is to be displayed in a secondary window rather than in the primary window. The name of the secondary window must have been defined in the [WINDOWS] section of the Help project (.HPJ) file.
uCommand
Specifies the type of help requested. For a list of possible values and how they affect the value to place in the dwData parameter, see the Remarks section.
dwData
Specifies additional data. The value used depends on the value of the uCommand parameter. For a list of possible values, see the Remarks section.
Return Values
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
Remarks
Before closing the window that requested Help, the application must call WinHelp with the uCommand parameter set to HELP_QUIT. Until all applications have done this, Windows Help will not terminate. Note that calling WinHelp with the HELP_QUIT command is not necessary if you used the HELP_CONTEXTPOPUP command to start Help The following table shows the possible values for the uCommand parameter and the corresponding formats of the dwData parameter:
uCommand Action dwData HELP_COMMAND Executes a Help macro or macro string. Address of a string that specifies the name of the Help macro(s) to execute. If the string specifies multiple macros names, the names must be separated by semicolons. You must use the short form of the macro name for some macros because Help does not support the long name. HELP_CONTENTS Displays the topic specified by the Contents option in the [OPTIONS] section of the .HPJ file. This is for backward compatibility. New applications should provide a .CNT file and use the HELP_FINDER command. Ignored, set to 0. HELP_CONTEXT Displays the topic identified by the specified context identifier defined in the [MAP] section of the .HPJ file. Unsigned long integer containing the context identifier for the topic. HELP_CONTEXTPOPUP Displays, in a pop-up window, the topic identified by the specified context identifier defined in the [MAP] section of the .HPJ file. Unsigned long integer containing the context identifier for a topic. HELP_FORCEFILE Ensures that WinHelp is displaying the correct help file. If the incorrect help file is being displayed, WinHelp opens the correct one; otherwise, there is no action. Ignored, set to 0. HELP_HELPONHELP Displays help on how to use Windows Help, if the WINHELP.HLP file is available. Ignored, set to 0. HELP_INDEX Displays the Index in the Help Topics dialog box. This command is for backward compatibility. New applications should use the HELP_FINDER command. Ignored, set to 0. HELP_KEY Displays the topic in the keyword table that matches the specified keyword, if there is an exact match. If there is more than one match, displays the Index with the topics listed in the Topics Found list box. Address of a keyword string. HELP_MULTIKEY Displays the topic specified by a keyword in an alternative keyword table. Address of a MULTIKEYHELP structure that specifies a table footnote character and a keyword. HELP_PARTIALKEY Displays the topic in the keyword table that matches the specified keyword, if there is an exact match. If there is more than one match, displays the Index tab. To display the Index without passing a keyword (the third result), you should use a pointer to an empty string. Address of a keyword string. HELP_QUIT Informs the Help application that it is no longer needed. If no other applications have asked for Help, Windows closes the Help application. Ignored, set to 0. HELP_SETCONTENTS Specifies the Contents topic. The Help application displays this topic when the user clicks the Contents button. Unsigned long integer containing the context identifier for the Contents topic. HELP_SETINDEX Specifies a keyword table to be displayed in the Index of the Help Topics dialog box. Unsigned long integer containing the context identifier for the Index topic. HELP_SETWINPOS Displays the Help window, if it is minimized or in memory, and sets its size and position as specified. Address of a HELPWININFO structure that specifies the size and position of either a primary or secondary Help window.
See Also
HELPWININFO, MULTIKEYHELP
| Пригласи друзей и счет твоего мобильника всегда будет положительным! |
| Пригласи друзей и счет твоего мобильника всегда будет положительным! |
WinHelp
Функция WinHelp начинает Подсказку Windows (WINHELP.EXE) и передает дополнительные данные указывая, что природа подсказки запрашивалась приложением. Приложение определяет имя и, где необходимо, путь директория файла подсказки, чтобы отображаться.
BOOL WinHelp(
HWND hWndMain, // РУЧКА окна, запрашивающего Подсказку LPCTSTR lpszHelp, // адрес директория-пути строки UINT uCommand, // типа дополнительных данных Подсказки DWORD dwData // );
Параметры
hWndMain
Идентифицирует окно, запрашивающее Подсказку. Функция WinHelp использует эту ручку, чтобы следить из которого приложения запросили Подсказку.
lpszHelp
Точки на недействительный расторгнутую строку, содержащие путь, если необходимо, и имя файла Подсказки, что приложение Подсказки должно отображать. filename Мочь последовать за скобкой угла (>) и имя второстепенного окна если тема должна быть отображена во второстепенном окне а не в первичном окне. Имя второстепенного окна по-видимому определено в [WINDOWS] секции проекта Подсказки (.HPJ) ФАЙЛ.
uCommand
Определяет тип запрошенной подсказки. Для списка возможных величин и как они влияют на величину, чтобы устанавливаться в параметре dwData, смотри секцию Замечаний.
dwData
Определяет дополнительные данные. Использованная величина зависит от величины параметра uCommand. Для списка возможных величин, смотри секцию Замечаний.
Обратные Величины
Если функция добивается успеха, обратная величина ненулевая. Если функция терпит неудачу, обратная величина нулевая.
Замечания
Перед закрытием окна, что запросившее Подсказку, приложение должно назвать WinHelp с параметром uCommand установленным на HELP_QUIT. Пока все приложения не сделали это, Подсказка Windows не завершится. Отметьте, что вызывая WinHelp с командой HELP_QUIT не необходимо если Вы использовали бы команду HELP_CONTEXTPOPUP, чтобы запускать Подсказку, которую следующая таблица показывает возможным величинам для параметра uCommand и соответствующие форматы параметра dwData:
uCommand Action dwData HELP_COMMAND Выполняет Подсказку макро или макро строка. Адресуйте строку, которая определяет имя макро Подсказки(подсказок), чтобы выполняться. Если строка определяет многочисленные имена макро, имена должны быть разделены точками с запятой. Вы должны использовать короткую форму макро называть в честь некоторых макро поскольку Подсказка не поддерживает длинное имя. HELP_CONTENTS Отображает тему определенную опцией Содержания в [OPTIONS] секции файла .HPJ. Это - для отсталой совместимости. Новые приложения должны обеспечить файл .CNT и использовать команду HELP_FINDER. Проигнорированное, установленное на 0. HELP_CONTEXT Отображает тему идентифицированную определенным контекстным идентификатором определенным в [MAP] секции файла .HPJ. Без знака длинное целое, содержащее контекстный идентификатор для темы. HELP_CONTEXTPOPUP Отображает, в управляющем окне, тема идентифицировалась определенным контекстным идентификатором определенным в [MAP] секции файла .HPJ. Без знака длинное целое, содержащее контекстный идентификатор для темы. HELP_FORCEFILE Проверяет, что WinHelp отображает правильный файл подсказки. Если неправильный файл подсказки отображается, WinHelp открывает правильный один; в противном случае, нет действия. Проигнорированное, установленное на 0. HELP_HELPONHELP Отображает подсказку о том как использовать Подсказку Windows, если файл WINHELP.HLP доступен. Проигнорированное, установленное на 0. HELP_INDEX Отображает Индекс в Темах Подсказки диалогового блока. Эта команда - для отсталой совместимости. Новые приложения должны использовать команду HELP_FINDER. Проигнорированное, установленное на 0. HELP_KEY Отображает тему в таблице ключевого слова, которая соответствует определенному ключевому слову, если есть точное сопоставление. Если есть более, чем один сопоставление, отображает Индекс с темами указанными в Темах Обнаружившими блока списка. Адресуйте строку ключевого слова. HELP_MULTIKEY Отображает тему определенную ключевым словом в альтернативной таблице ключевого слова. Адресуйте структуру MULTIKEYHELP, которая определяет табличный символ сноски и ключевое слово. HELP_PARTIALKEY Отображает тему в таблице ключевого слова, которая соответствует определенному ключевому слову, если есть точное сопоставление. Если есть более, чем один сопоставление, отображает таб. Индекса. Чтобы отображать Индекс не передавая ключевое слово ( третий результат), Вы должны использовать указатель в пустую строку. Адресуйте строку ключевого слова. HELP_QUIT Сообщает приложение Подсказки, что это не - больше не нужно. Если никакие другие приложения не потребовали бы Help, Windows закрывает приложение Подсказки. Проигнорированное, установленное на 0. HELP_SETCONTENTS Определяет тему Содержания. Приложение Подсказки отображает эту тему когда пользователь щелкает кнопку Содержания. Без знака длинное целое, содержащее контекстный идентификатор для темы Содержания. HELP_SETINDEX Определяет таблицу ключевого слова, которая нужно отображаться в Индексе Тем Подсказки диалогового блока. Без знака длинное целое, содержащее контекстный идентификатор для темы Индекса. HELP_SETWINPOS Отображает окно Подсказки, если минимизировано или в памяти и устанавливает свой размер и позиционирует как определено. Адресуйте структуру HELPWININFO, которая определяет размер и позицию или первичное или второстепенное окно Подсказки.
Смотри Также
HELPWININFO, MULTIKEYHELP
|
|
|
|
| |