wpclsSetSetting
Appearance
This method sets the class object settings in the Settings notebook.
Syntax
_wpclsSetSetting(somSelf, pszSetting, pValue);
Parameters
- somSelf (M_WPAbstract *) - input
- Pointer to the WPAbstract class object.
- pszSetting (PSZ) - input
- Name of the setting that is to be set.
- pValue (PVOID) - input
- Buffer which contains setting values.
- rc (BOOL) - returns
- Success indicator.
- TRUE: Successful completion.
- FALSE: Error occurred.
Remarks
This is a virtual method and must be overridden by a subclass. Each object subclass documents the possible values for **pszSetting** and **pValue**. These settings and values are specific for each subclass. Note that all settings have safe defaults, so it is never necessary to pass unnecessary settings to an object.
For a list of settings and their associated values, see the individual classes.
Usage
This method should never be called. It is a virtual method and must be overridden by a subclass.
How to Override
This is a virtual method and must be overridden by a subclass.
Example Code
Declaration:
#define INCL_WINWORKPLACE #include <os2.h> M_WPAbstract *somSelf; /* Pointer to the WPAbstract class object. */ PSZ pszSetting; /* Name of the setting that is to be set. */ PVOID pValue; /* Buffer which contains setting values. */ BOOL rc; /* Success indicator. */ rc = _wpclsSetSetting(somSelf, pszSetting, pValue);