Jump to content

wpObjectReady

From EDM2

This instance method is called as a notification to the object that its creation or awakening is complete.

Syntax

_wpObjectReady(somSelf, ulCode, refObject)

Parameters

somSelf (WPObject *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPObject.
ulCode (ULONG) - input
Code indicating the type of operation which has just completed.
Possible values are described in the following list:
  • OR_AWAKE - object awakened from dormancy.
  • OR_FROMTEMPLATE - Self created from template object refObject.
  • OR_FROMCOPY - Self created as a copy of refObject.
  • OR_NEW - New object created.
  • OR_SHADOW - Self created as a shadow of refObject.
  • OR_REFERENCE - Set to indicate that the new object (self) was created from the refObject.
refObject (WPObject *) - input
Pointer to the object from which this object was created.
If OR_REFERENCE is set in ulCode, this is a pointer to the object from which self was created; otherwise, it is NULL.

Returns

There is no return value for this method.

Remarks

The last step of object creation or awakening is the invocation of wpObjectReady. This is a notification to the object indicating completion of the creation or awakening operations.

Usage

This method was originally created to indicate when it is safe to call wpSaveDeferred on a newly instantiated object.

How to Override

This method is overridden to receive this notification. The parent method should be called in the override to this method.

Related Methods