Method XbpHelp():showHelp() Foundation
Displays the specified help window of the online help.
:showHelp( [<nID> | <cName>] ) --> lSuccess
This method returns .T. (true) if the specified help window is displayed, otherwise .F. (false) is returned.
The method :showHelp() is used to display the help text with the specified ID or symbolic name in the online help.
IPF-based help (OS/2)
The ID must be defined in the IPF source code heading tag (:h1. to :h6.). The ID can be either a numeric ID (attribute res=) or a symbolic ID (attribute id=). If the help text is identified by a numeric ID, the ID is passed to the :showHelp() method as a numeric value <nID>. If the help text is identified using a symbolic ID <cName>, it is passed as a character string.
If the :showHelp() method is called without an argument, the help window with the title "Using the Help Facility" is displayed. This window can also be displayed by selecting the menu item "Using help Shift+F10" in the help window of the online help.
HTML-based help (Windows)
A character string with the name of the HTML file containing the text of a help window must be used as it is listed in the [FILES] section of the project file (HHP file). If the file does not exist, the default window of the online help is displayed by the method :showHelp().
RTF-based help (Windows)
Help windows are identified with the footnote #{\footnote <cName> } in the RTF source code. Therefore, passing a character string containing the symbolic name of a help window to :showHelp() is recommended. If a numeric ID is used, it must be mapped to its symbolic counterpart in the [MAP] section of the help project file (HPJ file).
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.