4. System Classes : SessionObject Class : WinHelp Method
 
Share this page                  
WinHelp Method
The WinHelp method displays a compiled help file.
This method has the following syntax:
integer = sessionobject.WinHelp(command = integer
          [, helpfile = varchar] [, context = integer ] [, topic = varchar])
This method has the following parameters:
command
(Required) Specifies one of the help commands listed in the following table
helpfile
Specifies the file name of the help file
context
Specifies the context ID
topic
Specifies the topic name
The following table explains how these parameters are are used:
command
helpfile
context
topic
Description
HV_HELPONHELP
Ignored
Ignored
Ignored
Displays how to use the help system
HV_CONTENTS
File name
Ignored
Ignored
Displays the contents page of a help file
HV_KEY
File name
Ignored
Topic name
Displays a specified topic in a help file
HV_CONTEXT
File name
Number
Ignored
Displays a specified numeric context in a help file
HV_QUIT
File name
Ignored
Ignored
Removes the help viewer
Descriptions of system constant values and their numeric equivalents are listed in Help Commands for SessionObject WinHelp Method (see Help Commands for SessionObject WinHelp Method).