StackOperations Namespace Reference

This namespace deals with CThingStack objects. More...

Functions
CENTUMSHAREDCODE_API CThing *	StackObjToCThing (StackObj *p)
	This function takes a stack object as a parameter and returns the CThing pointer that it is holding, or NULL if there is none, and releases the StackObj.
CENTUMSHAREDCODE_API CThing *	StackObjToCThingSafe (const StackObj *p)
	This function takes a stack object as a parameter and returns the CThing pointer that it is holding, or NULL if there is none.
CENTUMSHAREDCODE_API void	FinishCThingStack (CThingStack *s)
	This function takes a CThingStack pointer and releases it.

---

Detailed Description

This namespace deals with CThingStack objects.

---

Function Documentation

CENTUMSHAREDCODE_API void StackOperations::FinishCThingStack (  CThingStack *  s  )

This function takes a CThingStack pointer and releases it. This function releases the CThingStack with a call to IMemoryManager::Free(). It also calls the CThingStack::Destruct() function to clean up any data associated with the stack. Using the pointer after a call to this function is an error. Parameters: s  a valid CThingStack pointer, may be NULL

CENTUMSHAREDCODE_API CThing * StackOperations::StackObjToCThing (  StackObj *  p  )

This function takes a stack object as a parameter and returns the CThing pointer that it is holding, or NULL if there is none, and releases the StackObj. The StackObjToCThingSafe function examines the type of the StackObj and returns the appropriate value. The StackObj pointer IS not released by a call to this function, but the reference count of the CThing affected. Calling this function on a StackObj that is still part of the stack is an error. See also: StackObjToCThingSafe() Parameters: p  a valid StackObj pointer, may be NULL Returns: the CThing pointer, if any, inside the StackObj

CENTUMSHAREDCODE_API CThing * StackOperations::StackObjToCThingSafe (  const StackObj *  p  )

This function takes a stack object as a parameter and returns the CThing pointer that it is holding, or NULL if there is none. The StackObjToCThingSafe function examines the type of the StackObj and returns the appropriate value. The StackObj pointer is not released by a call to this function, nor is the reference count of the CThing affected. See also: StackObjToCThing() Parameters: p  a valid StackObj pointer, may be NULL Returns: the CThing pointer, if any, inside the StackObj

---