Jump to content

wpSaveCellData

From EDM2
Revision as of 02:24, 17 November 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpSaveCellData}} This method is specific to version 3, or higher, of the OS/2 operating system. This instance method saves the data for the specified cell. ==Syntax== _wpSaveCellData(somSelf, pCell, ulIndex) ==Parameters== ;''somSelf'' (WPPalette *) - input :Pointer to the object on which the method is being invoked. :Points to an object of class WPPalette. ;''pCell'' (PCELL) - input :Pointer to the cell whose data is to be saved. ;''ulIn...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This method is specific to version 3, or higher, of the OS/2 operating system.

This instance method saves the data for the specified cell.

Syntax

_wpSaveCellData(somSelf, pCell, ulIndex)

Parameters

somSelf (WPPalette *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPPalette.
pCell (PCELL) - input
Pointer to the cell whose data is to be saved.
ulIndex (ULONG) - input
Cell index. This is the number of the cell. It must be within the range **0** to **xCellCount*yCellCount-1**.

Returns

rc (BOOL) - returns
Success indicator.
  • TRUE Successful completion.
  • FALSE Error occurred.

How to Override

This method **should** be overridden by all subclasses that wish to save and restore part of their cell data. It should be overridden when special processing is to be done for subclassed palettes. This method **must** be overridden by all subclasses that change the size of their cell data. For example, the scheme palette saves the name of the background bit map for the scheme.

Usage

This method is called by the system while it is processing wpSaveState for WPPalette.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPPalette *somSelf; /* Pointer to the object on which the method is being invoked. */
PCELL *pCell; /* Pointer to the cell whose data is to be saved. */
ULONG ulIndex; /* Cell index. */
BOOL rc; /* Success indicator. */

rc = _wpSaveCellData(somSelf, pCell, ulIndex);

Related Methods