wpclsQueryDefaultHelp
This class method is called to allow the class object to specify its default help panel for its instances.
Syntax
rc = _wpclsQueryDefaultHelp(somSelf, HelpPanelId, HelpLibrary);
Parameters
- somSelf (M_WPObject *) - input
- Pointer to the WPObject class object.
- HelpPanelId (PULONG) - output
- Pointer to the help panel which provides help for this class.
- HelpLibrary (PSZ) - output
- Pointer to the buffer in which to place the name of the Help library. This buffer should be at least the length of CCHMAXPATH bytes.
Returns
- rc (ULONG) - returns
- Success indicator.
Value Description TRUE Successful completion. FALSE Error occurred.
Remarks
This class method is called during the default processing of wpQueryDefaultHelp.
Usage
This method can be called at any time in order to determine the default help panel for this object class.
How to Override
The default WPObject class does not process this method other than returning FALSE.
Example Code
This example provides general help for the Spread (sheet) instance:
SOM_Scope BOOL SOMLINK SpreadM_wpclsQueryDefaultHelp(M_Spread *somSelf,
PULONG pHelpPanelId,
PSZ pszHelpLibrary)
{
/* M_SpreadData *somThis = M_SpreadGetData(somSelf); */
M_SpreadMethodDebug("M_Spread","SpreadM_wpclsQueryDefaultHelp");
if (pHelpPanelId) /* set default help panel id */
*pHelpPanelId = PANEL_MAIN;
if (pszHelpLibrary) /* copy help filename */
strcpy(pszHelpLibrary, "spdsheet.hlp");
return( TRUE ); /* Help exists */
}