Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

CThingArray.cpp File Reference

This file contains the implentation of the CThingArray class. More...

#include "CentumSharedCode.h"

Include dependency graph for CThingArray.cpp:


Functions

CENTUMSHAREDCODE_API void FillWithStack (CThingArray *a, CThingStack *s)
 The FillWithStack function takes a CThingStack and adds its elements to the CThingArray.
CENTUMSHAREDCODE_API void ReleaseAll (CThingArray *a)
 The ReleaseAll function calls ReleaseCThing on all elements of the array and then destroys the array.

Detailed Description

This file contains the implentation of the CThingArray class.


Function Documentation

CENTUMSHAREDCODE_API void FillWithStack CThingArray a,
CThingStack s
 

The FillWithStack function takes a CThingStack and adds its elements to the CThingArray.

The CThingStack is emptied added to the array from top to bottom. This operation stops as soon as it finds a NULL CThing pointer, which may not necessarily be the entire stack. CThings taken off the stack are not dereferenced, it is your responsibility to clean up after using this function, probably by a call to ReleaseAll.

See also:
CThingArray

CThingStack

ReleaseAll()

Parameters:
a the CThingArray the stack elements will be added to.
s the CThingStack that the elements are taken off of.

CENTUMSHAREDCODE_API void ReleaseAll CThingArray a  ) 
 

The ReleaseAll function calls ReleaseCThing on all elements of the array and then destroys the array.

Make sure that when you call this function that you want to call ReleaseCThing on all the elements, and not for example ReleaseCThingGC. Also all of the pointers need either to be valid or NULL or an error will result.

See also:
CThingArray

FillWithStack()

Parameters:
a the CThingArray with the elements to be released.


Generated on Sat Apr 16 16:31:09 2005 for Centum API by  doxygen 1.4.2