wpclsMakeAwake
This class method is called to allow the specified class to awaken an object.
Syntax
_wpclsMakeAwake(somSelf, pTitle, ulStyle, hptrIcon, pObjData, Folder, ulUser);
Parameters
- somSelf (M_WPObject *) - input
- Pointer to the WPObject class object.
- pTitle (`PSZ`) - input
- Pointer to a string containing a title to set on the object. If this value is NULL, the class default value is used.
- ulStyle (`ULONG`) - input
- Object style flags to set on the object. If this value is NULL, the current or default value is used. Predefined object style bits are as follows:
- OBJSTYLE_CUSTOMICON: Destroy the icon when the object goes to sleep.
- OBJSTYLE_NOCOPY: Do not allow copy on the object.
- OBJSTYLE_NODELETE: Do not allow delete on the object.
- OBJSTYLE_NODDRAG: Do not allow drag of this object.
- OBJSTYLE_NODDROPON: Do not allow dropping on this object.
- OBJSTYLE_NOLINK: Do not allow linking on the object.
- OBJSTYLE_NOMOVE: Do not allow moving on the object.
- OBJSTYLE_NOPRINT: Do not allow printing of this object.
- OBJSTYLE_NORENAME: Do not allow renaming of the object.
- OBJSTYLE_NOTVISIBLE: Make this object hidden.
- OBJSTYLE_NODSETTINGS: Do not allow setting of this object.
- OBJSTYLE_TEMPLATE: This object is a template.
- hptrIcon (`HPOINTER`) - input
- Icon to set on the object. If this value is NULL, the class default value is used.
- pObjData (`POBJDATA`) - input
- Pointer to the object data. If this value is NULL, the class default value is used.
- Folder (`WPFolder` *) - input
- Pointer to a Folder object that contains the new object. This pointer can be determined by issuing a call to the wpclsQueryFolder method.
- ulUser (`ULONG`) - input
- Base class-defined value. This value is defined by the user and used by the base storage class.
Returns
- Success (WPObject *) - returns
- Success indicator.
Value Description Non-NULL Pointer to the awakened object. NULL Error occurred.
Remarks
An object is made awake when it is created in an open folder or when a folder containing the object is opened. An object awakened by the `wpclsMakeAwake` class method is automatically locked. The wpUnlockObject method can be called to allow the object to return to its dormant state.
Usage
This method is generally called only by base storage classes in order to awaken an object from the dormant state.
How to Override
This method is generally not overridden.