WinHelp

Calls a Windows help file.

Syntax:

WinHelp (help-file, function, keyword)

Parameters:

(s) help-file name of the Windows help file, with an optional full path.

(s) function function to perform (see below).

(s) keyword keyword to look up in the help file (if applicable), or "".

Returns:

(i) @TRUE if successful @FALSE if unsuccessful.

 

This command can be used to perform several functions from a Windows help (.HLP) file. It requires that the Windows help program WINHELP.EXE be accessible. The desired function is indicated by the "function" parameter (which is not case-sensitive). The possible choices for "function" are:

 

Function

Keyword

"Contents"

Brings up the Contents page for the help file. Specify a null string ("") for the "keyword" parameter.

"Key"

Brings up help for the keyword specified by the "keyword" parameter. You must specify a complete keyword, and it must be spelled correctly. If there is more than one occurrence of "keyword" in the help file, a search box will be displayed which allow you to select the desired topic from the available choices.

"PartialKey"

Brings up help for the keyword specified by the "keyword" parameter. You may specify a partial keyword name: if it matches more than one keyword in the help file, a search box will be displayed which allow you to select the desired one from the available choices. You may also specify a null string ("") for "keyword", in which case you will get a search dialog containing all keywords in the help file.

"Context"

Brings up help for the topic specified by "keyword". "Keyword" must be a numeric context identifier defined in the [MAP] section of the .HPJ file that was used to build the help file.

"Command"

Executes the help macro specified by the "keyword" parameter.

"Quit"

Closes the WINHELP.EXE window, unless another application is still using it. Specify a null string ("") for the "keyword" parameter.

"HelpOnHelp"

Brings up the help file for the Windows help program (WINHELP.HLP). Specify a null string ("") for the "keyword" parameter.

"HTML"

Launches HH.EXE to view a topic in an HTML help (.CHM) file. "Keyword" specifies the topic to display, or "" to view the starting topic in the file.

Example:

 

WinHelp("iexplore.chm", "HTML", "web_collect_favorites.htm")

 

Which is identical To:

 

Run("HH.EXE", "iexplore.chm::/web_collect_favorites.htm")

 

Note: WILHH.EXE is a WinBatch utility that augments HTML Help. WILHH can be used In addition To or as a complete replacement For HH.EXE. WILHH offers solutions For some known bugs In HTML Help. WILHH helps you To resolve these problems with HH.EXE:

 

- OPEN a standalone HTML Help window. Ask WILHH To create a standalone HTML Help window. This window remains OPEN until the user closes it. Once this window is created, you can OPEN new topics In the window without creating a new window, just as you can with WinHelp.

 

- OPEN an HTML Help window based ON a keyword search. A common way of linking topics in a help system is through keyword and associative links--KLinks and ALinks, In WinHelp terminology. However, WILHH also allows you to OPEN the new topics in a window that is already open. In addition, WILHH allows you To use ALinks and KLinks In ways that HH.EXE doesn't support.

 

WILHH Commandline:

WILHH.EXE {CHM}  Opens a CHM file To its main page.

WILHH.EXE {CHM} [{KEYWORD}:] Opens a CHM file and loads a topic based ON keyword. Note: KEYWORD can specified one or more ALink names or KLink keywords To look up. MULTIPLE entries are delimited By a semicolon.

 

 

 
Example:
DirChange(DirHome())
DirChange("..")
WinHelp("WinBatch.chm", "HTML", "")