The WinHelp function starts Windows Help (WINHELP.EXE) and passes additional data indicating the nature of the help requested by the application.
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 |
); |
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.
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
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 Windows Help with the HELP_QUIT command is not necessary if you used the HELP_CONTEXTPOPUP command to start Windows 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 run. If the string specifies multiple macro names, the names must be separated by semicolons. You must use the short form of the macro name for some macros because Windows 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 command 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_CONTEXTMENU |
Displays the Help menu for the selected window, then displays the topic for the selected control in a pop-up window. |
Address of an array of double word pairs. The first double word in each pair is a control identifier, and the second is a context number for a topic. |
HELP_CONTEXTPOPUP |
Displays the topic identified by the specified context identifier defined in the [MAP] section of the .HPJ file in a pop-up window. |
Unsigned long integer containing the context identifier for a topic. |
HELP_FINDER |
Displays the Help Topics dialog box. |
Ignored; set to 0. |
HELP_FORCEFILE |
Ensures that Windows Help is displaying the correct help file. If the incorrect help file is being displayed, Windows Help 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 WINHLP32.HLP file is available. |
Ignored, set to 0. |
HELP_INDEX |
Displays the topic specified by the CONTENTS option in the [OPTIONS] section of the .HPJ file. 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. Multiple keywords must be separated by semicolons. |
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 Topics Found dialog box. To display the Index without passing a keyword, you should use a pointer to an empty string. |
Address of a keyword string. Multiple keywords must be separated by semicolons. |
HELP_QUIT |
Informs Windows Help that it is no longer needed. If no other applications have asked for Help, Windows closes Windows Help. |
Ignored, set to 0. |
HELP_SETCONTENTS |
Specifies the Contents topic. Windows Help displays this topic when the user clicks the Contents button if the help file does not have an associated .CNT file. |
Unsigned long integer containing the context identifier for the Contents topic. |
HELP_SETPOPUP_POS |
Sets the position of the subsequent pop-up window. |
Address of a POINTS structure. The pop-up window is positioned as if the mouse cursor were at the specified point when the pop-up window is invoked. |
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. |
HELP_TCARD |
Indicates that a command is for a training card instance of Windows Help. Combine this command with other commands using the bitwise OR operator. |
Depends on the command with which this command is combined. |
HELP_WM_HELP |
Displays the topic for the control identified by the hWndMain parameter in a pop-up window. |
Address of an array of double word pairs. The first double word in each pair is a control identifier, and the second is a context identifier for a topic. |
file: /Techref/os/win/api/win32/func/src/f91_15.htm, 11KB, , updated: 2000/4/7 11:13, local time: 2024/11/7 11:25,
13.59.163.1:LOG IN ©2024 PLEASE DON'T RIP! THIS SITE CLOSES OCT 28, 2024 SO LONG AND THANKS FOR ALL THE FISH!
|
©2024 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions? <A HREF="http://techref.massmind.org/techref/os/win/api/win32/func/src/f91_15.htm"> WinHelp</A> |
Did you find what you needed? |
Welcome to massmind.org! |
Welcome to techref.massmind.org! |
.