Class CObjectConIx

class CObjectConIx : public CBase;

Description

A container for object containers

This is referred to as a container index.

The class provides the mechanism through which object containers, CObjectCon types, are created.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CObjectConIx - A container for object containers

Members

Defined in CObjectConIx:
CObjectConIx(), CreateL(), Lookup(), NewL(), Remove(), ~CObjectConIx()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CObjectCon
• CObject

static IMPORT_C CObjectConIx *NewL();

Description

Creates a new container index.

Return value

CObjectConIx * A pointer to the newly created container index.

IMPORT_C ~CObjectConIx();

Description

Destructor.

Frees all resources owned by the container index, prior to its destruction.

In particular, it destroys all of its contained object containers.

protected: IMPORT_C CObjectConIx();

Description

Default constructor.

IMPORT_C CObjectCon *Lookup(TInt aFindHandle) const;

Description

Gets a pointer to the object container with the unique ID from the specified find handle.

Parameters

TInt aFindHandle The find handle.

Return value

CObjectCon * A pointer to the object container with a matching unique ID. If no matching object container can be found, then this is NULL.

IMPORT_C CObjectCon *CreateL();

Description

Creates a new object container and adds it into this container index's collection.

In addition to creating the object container, the function assigns the next available unique ID to it.

Return value

CObjectCon * A pointer to the new object container.

IMPORT_C void Remove(CObjectCon *aCon);

Description

Removes the specified object container from this container index and deletes it.

Parameters

CObjectCon *aCon A pointer to the object container to be removed. If the pointer is NULL, the function just returns.

Panic codes

E32USER-CBASE 36 if the object container cannnot be found.