wpQueryPaletteInfo

This instance method is called to determine current information about the palette.

Syntax

_wpQueryPaletteInfo(somSelf, pPalInfo)

Parameters

somSelf (WPPalette *) - input

Pointer to the object on which the method is being invoked.

Points to an object of class WPPalette.

pPalInfo (PPALINFO) - input

Pointer to a PALINFO structure.

Returns

rc (BOOL) - returns

Success indicator.

• TRUE Successful completion.
• FALSE Error occurred.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to get current information about the palette.

Remarks

The palette information can be set by issuing a call to the wpSetPaletteInfo method.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPPalette *somSelf; /* Pointer to the object on which the method is being invoked. */
PPALINFO pPalInfo; /* Pointer to a PALINFO structure. */
BOOL rc; /* Success indicator. */

rc = _wpQueryPaletteInfo(somSelf, pPalInfo);

Related Methods

• wpSetPaletteInfo