Class CDaUserDbDesc

class CDaUserDbDesc : public CBase;

Description

Database application engine helper.

Derivation

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

• CDaUserDbDesc - Database application engine helper.

Members

Defined in CDaUserDbDesc:

• Col(TDbColNo)constGets a column specified by number.
• Col(const TDbColName &)constGets a column specified by name.
• ColName(TDbColNo)constGets the column name for a specified column number.
• ColNoFromUId(TInt)constGets a column specified by UID.
• ColSet()constGets the column set.
• ColumnCount()constGets the number of columns.
• CopyColSetL(const CDaUserColSet &)Sets the column definition set.
• DbColName(const TDbColName &)constGets a generated UID column name for a specified column.
• DbColNameFromUId(TInt)constGets a generated UID column name.
• DbColNo(TDbColNo,const CDbColSet *)constGets the user column number of a specified column in a column definition set.
• ExternalizeL(RWriteStream &)constExternalises the object's settings to a stream.
• InternalizeL(RReadStream &)Internalises the object's settings from a stream.
• NewL(CDaModel *)Allocates and constructs a new database application engine helper.
• NewL(const TFileName &,CDaUserColSet *,CDaModel *)Allocates and constructs a new database application engine helper.
• SetDbColNo(const CDbColSet &)Sets column numbers from a specified column set.
• SetReserveL(TInt)Reserves space for columns to be added in future.
• TableName()constGets the table name (const overload).
• TableName(const TFileName &)Gets the table name.
• UId(TDbColNo)constGets the UID field for a column specified by number.
• UId(const TDesC &)constGets the UID field for a column specified by name.
• UserColNo(const TDbColName &)constGets a column number for a named column.

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 static CDaUserDbDesc* NewL(CDaModel *aModel);

Description

Allocates and constructs a new database application engine helper.

Parameters

Return value

IMPORT_C static CDaUserDbDesc* NewL(const TFileName &aTableName, CDaUserColSet *aColSet, CDaModel *aModel);

Description

Allocates and constructs a new database application engine helper.

Parameters

Return value

IMPORT_C void ExternalizeL(RWriteStream &aSink) const;

Description

Externalises the object's settings to a stream.

Parameters

IMPORT_C void InternalizeL(RReadStream &aSource);

Description

Internalises the object's settings from a stream.

Parameters

IMPORT_C void CopyColSetL(const CDaUserColSet &aColSet);

Description

Sets the column definition set.

Parameters

inline void SetDbColNo(const CDbColSet &aColSet);

Description

Sets column numbers from a specified column set.

Parameters

inline void TableName(const TFileName &aTableName);

Description

Gets the table name.

Parameters

inline void SetReserveL(TInt aCount);

Description

Reserves space for columns to be added in future.

This ensures that out of memory errors will not occur when the columns are added.

Parameters

inline TInt ColumnCount() const;

Description

Gets the number of columns.

Return value

inline const TDaUserCol& Col(TDbColNo aColNo) const;

Description

Gets a column specified by number.

Parameters

Return value

IMPORT_C const TDaUserCol& Col(const TDbColName &aUserColName) const;

Description

Gets a column specified by name.

Parameters

Return value

IMPORT_C TDbColNo ColNoFromUId(TInt aUId) const;

Description

Gets a column specified by UID.

Parameters

Return value

IMPORT_C TDbColNo UserColNo(const TDbColName &aUserColName) const;

Description

Gets a column number for a named column.

Parameters

Return value

IMPORT_C TDbColNo DbColNo(TDbColNo aUserColNo, const CDbColSet *aDbColSet) const;

Description

Gets the user column number of a specified column in a column definition set.

! only works for single table database

Parameters

Return value

inline const TDbColName ColName(TDbColNo aUserColNo) const;

Description

Gets the column name for a specified column number.

Parameters

Return value

IMPORT_C TDbColName DbColName(const TDbColName &aUserColName) const;

Description

Gets a generated UID column name for a specified column.

Parameters

Return value

IMPORT_C TDbColName DbColNameFromUId(TInt aUid) const;

Description

Gets a generated UID column name.

Parameters

Return value

inline const TFileName& TableName() const;

Description

Gets the table name (const overload).

Return value

inline const CDaUserColSet& ColSet() const;

Description

Gets the column set.

Return value

IMPORT_C TInt UId(TDbColNo aUserColNo) const;

Description

Gets the UID field for a column specified by number.

Parameters

Return value

See also:

• TDaUserCol::iUIdColumn UID.

IMPORT_C TInt UId(const TDesC &aColName) const;

Description

Gets the UID field for a column specified by name.

Parameters

Return value

See also:

• TDaUserCol::iUIdColumn UID.