Jump to content

wpUnlockObject

From EDM2

This instance method decrements an object's lock count.

Syntax

_wpUnlockObject(somSelf)

Parameters

somSelf (WPObject *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPObject.

Returns

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

Remarks

wpUnlockObject unlocks the specified object. When an object is unlocked, it automatically goes into the dormant state when it no longer has open views and its container is no longer open.

Usage

This method can be called at any time to decrement the object's lock count. This method is used in conjunction with other methods that create new instances of objects. If these methods are called with the fLock flag set to TRUE, the new object is locked into the awake state until the wpUnlockObject method is called.

How to Override

This method is generally not overridden.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPObject      *somSelf;       /* Pointer to the object on which the method is being invoked. */
BOOL          rc;             /* Success indicator. */

rc = _wpUnlockObject(somSelf);

Related Methods