Jump to content

wpQueryShadowedObject

From EDM2

This instance method is called to allow the shadow object to query the object it is currently linked to.

Syntax

_wpQueryShadowedObject(somSelf, fLock)

Parameters

somSelf (WPShadow *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPShadow.
fLock (BOOL) - input
Lock object flag.
If this flag is **FALSE**, the newly created object will be made dormant whenever the object and the folder containing the object are closed. If this flag is **TRUE**, the new flag will remain awake until the caller issues the **wpUnlockObject** method on it.

Returns

Success (WPObject *) - returns
Success indicator.
  • **NULL** Error occurred.
  • **Other** A pointer to the object this shadow is linked to.

How to Override

This method is generally not overridden.

Usage

This method is called at any time in order to determine the object that this shadow is currently linked to.

Remarks

This method is not covered in the provided text.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPShadow *somSelf; /* Pointer to the object on which the method is being invoked. */
BOOL fLock; /* Lock object flag. */
WPObject *Success; /* Success indicator. */

Success = _wpQueryShadowedObject(somSelf,
              fLock);

Related Methods