wpQueryDefaultHelp
This instance method is called to allow the object to specify its default help panel.
Syntax
_wpQueryDefaultHelp(somSelf, pHelpPanelId, HelpLibrary)
Parameters
- somSelf (WPObject *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPObject.
- pHelpPanelId (PULONG) - output
- Pointer to the help panel ID.
- HelpLibrary (PSZ) - output
- A pointer to a buffer in which to place the name of the help library. This buffer should be the length of CCHMAXPATH bytes.
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 determine the default 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. */ PULONG pHelpPanelId; /* Pointer to the help panel ID. */ PSZ HelpLibrary; /* Pointer to the help library. */ BOOL rc; /* Success indicator. */ rc = _wpQueryDefaultHelp(somSelf, pHelpPanelId, HelpLibrary);