WpCreateShadowObjectExt

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

This instance method is called to create a shadow of an object.

Syntax

_wpCreateShadowObjectExt(somSelf, Folder, fLock, pszSetup, shadowClass)

Parameters

somSelf (WPObject *) - input

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

Points to an object of class WPObject.

Folder (WPFolder *) - input

Pointer to a Folder object in which to place the new shadow object. This pointer can be determined by issuing a call to the wpclsQueryFolder method.

fLock (BOOL) - input

Lock object flag.

If this flag is **FALSE**, the new shadow object will be made dormant whenever the object and the folder containing the object are closed.

If this flag is **TRUE**, the new object will remain awake until the caller issues the wpUnlockObject method on it.

pszSetup (PSZ) - input

Pointer to a setup string.

shadowClass (M_WPObject *) - input

Class of the new shadow object.

Returns

Object (WPObject *) - returns

Pointer to the new shadow object.

A value of **NULL** indicates that an error occurred.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to create a shadow object for this object.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPObject *somSelf; /* Pointer to the object on which the method is being invoked. */
WPFolder *Folder; /* Pointer to a Folder object. */
BOOL fLock; /* Lock object flag. */
PSZ pszSetup; /* Pointer to a setup string. */
M_WPObject *shadowClass; /* Class of the new shadow object. */
WPObject *Object; /* Pointer to the new shadow object. */

Object = _wpCreateShadowObjectExt(somSelf,
            Folder, fLock, pszSetup, shadowClass);

Remarks

This method is used instead of wpCreateShadowObject when a setup string needs to be passed to the new shadow object or when the shadow is to be created as a subclass of a shadow.

Related Methods

• wpCreateShadowObject
• wpclsQueryFolder
• wpUnlockObject