wpSetupOnce
This method is specific to version 3, or higher, of the OS/2 operating system.
This instance method is called to allow the newly created object to initialize itself.
Syntax
_wpSetupOnce(somSelf, pszSetupString);
Parameters
- somSelf (WPObject *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPObject.
- pszSetupString (PSZ) - input
- Class specific setup parameters for an object.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE: Successful completion.
- FALSE: Error occurred.
Remarks
If wpSetupOnce returns FALSE, the creation of the object is terminated. The WPObject version of wpSetupOnce calls wpSetup. The pszSetupString contains a series of "keyname=value" pairs that change the behavior of the object. Multiple "keyname=value" pairs are separated by semicolons. For example:
"key=value;key2=value1,value2;"
If you want a literal semicolon inside one of your fields you must type the following: ^; A literal semicolon. Each object class documents the keynames and the parameters it expects to see immediately following. Note that all parameters have safe defaults, so it is never required to pass parameters to an object. For a listing of setup strings, see the individual object classes.
Usage
This method is generally only called by the system during the processing of wpclsNew and WinCreateObject. For more information about WinCreateObject, see the Presentation Manager Programming Reference.
How to Override
This method is overridden by classes which require initialization in addition to setup string processing.