wpSetDefaultHelp
This instance method is called to set the default help panel for the object.
Syntax
_wpSetDefaultHelp(somSelf, HelpPanelID, HelpLibrary)
Parameters
- somSelf (WPObject *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPObject.
- HelpPanelID (ULONG) - input
- Help panel identity.
- HelpLibrary (PSZ) - input
- A pointer to the name of the Help library. A NULL value implies that the default should be used.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE: Successful completion.
- FALSE: Error occurred.
Remarks
The default help panel for this class can be determined by calling the wpclsQueryDefaultHelp method.
Usage
This method can be called at any time in order to set the default help panel for this object.
How to Override
This method is generally not overridden.
Example Code
#define INCL_WINWORKPLACE #include <os2.h> WPObject *somSelf; /* Pointer to the object on which the method is being invoked. */ ULONG HelpPanelID; /* Help panel identity. */ PSZ HelpLibrary; /* Pointer to the name of the Help library. */ BOOL rc; /* Success indicator. */ rc = _wpSetDefaultHelp(somSelf, HelpPanelID, HelpLibrary);