ShowHelp
PowerScript function
Description
Provides access to a Microsoft Windows-based Help system or to
compiled HTML Help files that you have created for your PowerBuilder
application. When you call ShowHelp, PowerBuilder starts the Help
executable and displays the Help file you specify.
Syntax
|
1 |
ShowHelp ( helpfile, helpcommand {, typeid } ) |
|
Argument |
Description |
|---|---|
|
helpfile |
A string whose value is the name of the compiled HLP file |
|
helpcommand |
A value of the HelpCommand enumerated type. Values
|
|
typeid (optional) |
A number identifying the topic if helpcommand is Topic! or Do not specify typeid when helpcommand is Finder! or |
Return value
Integer.
Returns 1 if it succeeds and -1 if an error occurs. ShowHelp returns
-1 if you specify typeid when helpcommand is Finder! or Index!. If any
argument’s value is null, ShowHelp returns null.
Usage
To provide context-sensitive Help, use ShowHelp in appropriate
scripts throughout your application with specific topic IDs or
keywords.
If you specify Keyword! for helpcommand and the string in typeid is
not unique, the Help Search window displays.
For information on how to create online Help files for your
PowerBuilder application, see the section called “Providing Online Help for an Application” in Application Techniques.
Examples
This statement displays the Help index in the INQ.HLP file:
|
1 |
ShowHelp("C:PBINQ.HLP", Index!) |
This statement displays Help topic 143 in the file EMP.HLP
file:
|
1 |
ShowHelp("EMP.HLP", Topic!, 143) |
This statement displays the Help topic associated with the keyword
Part# in the file EMP.HLP:
|
1 |
ShowHelp("EMP.HLP", Keyword!, "Part#") |
This statement displays the Help search window. The word in the box
above the keyword list is the first keyword that begins with M:
|
1 |
ShowHelp("EMP.HLP", Keyword!, "M") |
See also