wpQueryPaletteHelp
This instance method returns the help panel ID that is displayed when the help pushbutton is used from an open palette view.
Syntax
_wpQueryPaletteHelp(somSelf)
Parameters
- somSelf (WPPalette *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPPalette.
Returns
- ulHelpPanelID (ULONG) - returns
- Help panel ID.
- The help panel ID within help module of this class is specified by the wpQueryDefaultHelp method for this object instance.
How to Override
All subclasses of WPPalette need to override this method to provide help about their open palette view window.
Usage
This method may be called at any time.
Remarks
This method returns the help panel ID that is visible from the open palette view. That panel should describe what the palette cells represent, how to edit them, and how to apply the cell values to other windows or objects. The palette object can specify class-default and instance-specific helps for the object in addition to this specialized help which applies only to the palette view.
Example Code
#define INCL_WINWORKPLACE #include <os2.h> WPPalette *somSelf; /* Pointer to the object on which the method is being invoked. */ ULONG ulHelpPanelID; /* Help panel ID. */ ulHelpPanelID = _wpQueryPaletteHelp(somSelf);