Classes

Method XbpHelp():showGeneralHelp() Foundation

OS/2 - Displays the help window containing the General help text.

Syntax
:showGeneralHelp() --> lSuccess
Return

This method returns .T. (true) if the help window containing the General help text is displayed, otherwise .F. (false) is returned.

Description

The CUA guidelines specify that the menu item "General help F2" should display a help window containing a general description of the application program or of the document being processed. The :showGeneralHelp() method displays this help window.

The help text for this window must be in the IPF format. The numeric ID res= of the corresponding IPF tag :h1. (to :h6.) must be assigned to the instance variable :resGeneralHelp before the :create()method is called in order for this help text to be displayed. Otherwise, calls to :showGeneralHelp() are ignored.

A standardized Help menu does not exist under Windows. This method opens the online help of the operating system on Windows platforms.

Feedback

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.