Help Procedure |
Version 5 |
Displays help file (.hlp or .chm) contents, index, search, keyword or topic window.
[ vbStatus= ] Help ( sHelpFile [, enCmd] [, dwWord [,sKeyword] [,hWnd])
The Help procedure syntax has the following parts:
|
Name |
Type |
Description |
|
vbStatus |
Bool |
Status. |
|
sHelpFile |
Val BString |
The file path to either a compiled help (.chm or .hlp). |
|
enCmd |
Val enumAHelpCommand |
Help command. |
|
dwWord |
Val DWord |
Data that required for aHelpContext, the context identifier for the topic. |
|
sKeyword |
Val BString |
Keyword string for aHelpKeyword |
|
hWnd |
Val AHandle |
Handle to the window requesting help. |
enumAHelpCommand can be one of the following:
|
Name |
Value |
Description |
|
aHelpContext |
0 (default) |
Display topic |
|
aHelpContents |
1 |
Display table of contents |
|
aHelpIndex |
2 |
Display Index |
|
aHelpSearch |
3 |
Display Search |
|
aHelpKeyword |
4 |
Display topic for keyword |
The help file can be created using third-party tools such as RoboHelp or using the Microsoft HTML Help Workshop.
The following examples shows different ways of calling the Help functions:
Help("C:\\VXIPNP\\winNT\\fl8840a\\fl8840a.hlp", aHelpContents)
Help("C:\\VXIPNP\\winNT\\fl8840a\\fl8840a.hlp", aHelpKeyword, 0, "fl8840a")
sHelpFile="c:\\projects\\ATEasy\\HelpTestExec\\TestExec\\TestExec.chm"
bRet=Help(sHelpFile, aHelpContents)
if not bRet
MsgBox("Help file, '"+sHelpFile+"' not found")
endif
HelpContextID, HelpFile, MsgBox, OnHelpContext, OnWhatsThisHelp, ShowHelpContext, ShowWhatsThis, ToolTipText, WhatsThisButton, WhatsThisHelpID, WhatsThisHelpText, WhatsThisMode