Jump to content

WpSetPaletteInfo: Difference between revisions

From EDM2
Created page with "{{DISPLAYTITLE:wpSetPaletteInfo}} This instance method is called to set palette information. ==Syntax== _wpSetPaletteInfo(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 completio..."
 
 
Line 10: Line 10:
:Points to an object of class [[WPPalette]].
:Points to an object of class [[WPPalette]].


;''pPalInfo'' ([[PPALINFO]]) - input
;''pPalInfo'' (P[[PALINFO]]) - input
:Pointer to a [[PALINFO]] structure.
:Pointer to a [[PALINFO]] structure.



Latest revision as of 17:20, 24 November 2025

This instance method is called to set palette information.

Syntax

_wpSetPaletteInfo(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 set the palette information.

Remarks

The palette information can be retrieved by issuing a call to wpQueryPaletteInfo.

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 = _wpSetPaletteInfo(somSelf, pPalInfo);

Related Methods