[<<Previous Entry]
[^^Up^^]
[Next Entry>>]
[Menu]
[About The Guide]
WinHelp( cHelpFile, nHelpType, ncData )-> <lSuccess>
------------------------------------------------------------------------------
PARAMETER:
<cHelpFile> Is the Name of the help file to use. Help Files have .HLP
extension and use a Windows own format.
<nHelpType> Selects the kind of service to execute, the default value
is HELP_INDEX. Windows offers multiple services through this
function, so it may be quite confusing to obtain all its
possibilities. This is the reason why we have created the
Help...() functions, which are specialized functions based
on WinHelp().
HELP_CONTEXT 1 Displays Help for a particular topic
HELP_INDEX 3 Displays the Help contents topic
HELP_SETINDEX 5 Determines the Contents topic
HELP_CONTEXTPOPUP Displays a topic in a pop-up window (8)
HELP_KEY 101 Displays the topic found in the keyword
HELP_PARTIALKEY Displays the topic found in the keyword
HELP_MULTIKEY 201 Displays the keyword Help topic
HELP_COMMAND 102 Executes a Help macro.
HELP_SETWINPOS Displays the Help window if minimized
HELP_FORCEFILE 9 Forces WinHelp to display the correct Help
HELP_HELPONHELP 4 Displays the Help Contents topic
HELP_QUIT 2 Closes the Help application
<ncData> Certain parameters according to the requested WinHelp()
<nHelpType> service.
DESCRIPTION:
The WinHelp function starts Windows Help (WINHELP.EXE) and passes optional
data indicating the nature of the help requested by the application. The
application specifies the name and, where required, the path of the help
file that the Help application is to display.
Before closing the window that requested the help, the application must
call WinHelp with <nHelpType> set to HELP_QUIT(2). Until all applications
have done this, Windows Help does not terminate.
SOURCE:
SOURCE\WINAPI\HELP.C
See Also:
HelpIndex
HelpSearch
HelpSetTopic
HelpTopic
SetHelpFile
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson