Class CDbColSet

class CDbColSet : public CBase;

Description

Manages a set of column definitions which describe a table or rowset structure. Column definitions can be added and removed. The set can be iterated over, and ordinals for a column can be looked up.

The class is not intended for user derivation.

Derivation

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

• CDbColSet - Manages a set of column definitions which describe a table or rowset structure. ...

Members

Defined in CDbColSet:

• AddL(const TDbCol &)Adds a column to the column set.
• CDbColSet()Constructs an empty column set.
• Clear()Removes all of the columns from the column set.
• Col(const TDesC &)constReturns a named column definition in the set. If such a column does not exist in...
• ColNo(const TDesC &)constReturns the ordinal for a particular column name in this column set. If such a c...
• Count()constReturns the number of column definitions in the set.
• NewL()Constructs a new empty column set and returns a pointer to it.
• NewLC()Constructs a new empty column set and returns a pointer to it — placing ...
• Remove(const TDesC &)Removes the named column from the set.
• operator[](TDbColNo)constReturns a column definition by its ordinal number in the set.
• ~CDbColSet()Frees resources owned by the object.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C CDbColSet();

Description

Constructs an empty column set.

IMPORT_C static CDbColSet* NewL();

Description

Constructs a new empty column set and returns a pointer to it.

Return value

CDbColSet * A pointer to the column set object.

IMPORT_C static CDbColSet* NewLC();

Description

Constructs a new empty column set and returns a pointer to it — placing the pointer onto the cleanup stack. This allows the column set object and allocated resources to be cleaned up if a subsequent leave occurs.

Return value

CDbColSet * A pointer to the column set object.

IMPORT_C ~CDbColSet();

Description

Frees resources owned by the object.

inline const TDbCol& operator[](TDbColNo aCol) const;

Description

Returns a column definition by its ordinal number in the set.

Note that using a TDbColSetIter is another way to iterate through the contents of a CDbColSet.

Parameters

TDbColNo aCol The ordinal number of the column in the set. Columns in a column set are numbered from 1 to CDbColSet::Count()const, unlike Symbian OS array classes. Ordinal 0 is reserved to represent the invalid column number KDbNullColNo.

Return value

const TDbCol & The column definition requested.

IMPORT_C const TDbCol* Col(const TDesC &aColName) const;

Description

Returns a named column definition in the set. If such a column does not exist in the set NULL is returned.

Parameters

const TDesC16 &aColName The name of the column to find.

Return value

const TDbCol * A pointer to the column definition found, or NULL.

IMPORT_C TDbColNo ColNo(const TDesC &aColName) const;

Description

Returns the ordinal for a particular column name in this column set. If such a column does not exist in the set the special ordinal KDbNullColNo is returned.

This function is particularly important when accessing data through a rowset. If the set of columns to be returned by a rowset is not explicitly specified, no assumptions should be made about the ordering of the columns returned. In such a case, in order to access the column data a column ordinal is required, and this can be obtained by using this function on the column set returned by RDbRowSet::ColSetL()const.

Parameters

const TDesC16 &aColName The name of the column to find.

Return value

TDbColNo The ordinal number of the column.

inline TInt Count() const;

Description

Returns the number of column definitions in the set.

Note that using a TDbColSetIter is another way to iterate through the contents of a CDbColSet.

Return value

TInt The number of columns in the columns set.

inline void Clear();

Description

Removes all of the columns from the column set.

IMPORT_C CDbColSet& AddL(const TDbCol &aCol);

Description

Adds a column to the column set.

Parameters

const TDbCol &aCol The column to add to the set.

Return value

CDbColSet & A reference to this object.

IMPORT_C void Remove(const TDesC &aColName);

Description

Removes the named column from the set.

Parameters

const TDesC16 &aColName The name of the column to remove from the set.