Method XbpHelp():create() Foundation

Requests system resources for the XbpHelp object.

Syntax
:create( [<oOwner>], <cHelpFile>, [<cTitle>] ) --> self
Parameters
<oOwner>
<oOwner> optionally specifies the owner for the XbpHelp object. By default the current window (the return value of SetAppWindow()) is the owner, but any dialog element can be passed as <oOwner>.
<cHelpFile>
The <cHelpFile> parameter is a character string specifying the file name of the HLP file. The file extension must be included in the file name. The HLP file must be located either in the current directory or in one of the directories specified in the path defined by the environment variable SET HELP=.
<cTitle>
<cTitle> is an optional character expression that defines the title for the window of the online help.
Return

This method returns the object executing the method (self).

Description

Executing the method :create() is important in the life cycle of each XbpHelp object. After an XbpHelp object is instantiated, the object exists but is not yet operational. System resources must be requested from OS/2 to provide the window for the online help. This is done using the method :create(). This method has the same parameter list as the method :new(). This means that the <oOwner>, <cHelpFile>, and <cTitle> can be specified either in the method :new() or the method :create().

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.