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(), Col(), ColName(), ColNoFromUId(), ColSet(), ColumnCount(), CopyColSetL(), DbColName(), DbColNameFromUId(), DbColNo(), ExternalizeL(), InternalizeL(), NewL(), NewL(), SetDbColNo(), SetReserveL(), TableName(), TableName(), UId(), UId(), UserColNo()

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

static IMPORT_C CDaUserDbDesc *NewL(CDaModel *aModel);

Description

Allocates and constructs a new database application engine helper.

Parameters

CDaModel *aModel Database application engine

Return value

CDaUserDbDesc * New database application engine helper

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

Description

Allocates and constructs a new database application engine helper.

Parameters

const TFileName &aTableName Database table name CDaUserColSet *aColSet Database application column set CDaModel *aModel Database application engine

Return value

CDaUserDbDesc * New database application engine helper

IMPORT_C void ExternalizeL(RWriteStream &aSink) const;

Description

Externalises the object's settings to a stream.

Parameters

RWriteStream &aSink Stream to which to write

IMPORT_C void InternalizeL(RReadStream &aSource);

Description

Internalises the object's settings from a stream.

Parameters

RReadStream &aSource Stream from which to read

IMPORT_C void CopyColSetL(const CDaUserColSet &aColSet);

Description

Sets the column definition set.

Parameters

const CDaUserColSet &aColSet Column definition set to use

inline void SetDbColNo(const CDbColSet &aColSet);

Description

Sets column numbers from a specified column set.

Parameters

const CDbColSet &aColSet Column set

inline void TableName(const TFileName &aTableName);

Description

Gets the table name.

Parameters

const TFileName &aTableName Table name

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

TInt aCount Number of columns to reserve space for

inline TInt ColumnCount() const;

Description

Gets the number of columns.

Return value

TInt Number of columns

inline const TDaUserCol &Col(TDbColNo aColNo) const;

Description

Gets a column specified by number.

Parameters

TDbColNo aColNo Column number to get

Return value

const TDaUserCol & Column

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

Description

Gets a column specified by name.

Parameters

const TDbColName &aUserColName Column number to get

Return value

const TDaUserCol & Column

IMPORT_C TDbColNo ColNoFromUId(TInt aUId) const;

Description

Gets a column specified by UID.

Parameters

TInt aUId Column UID

Return value

TDbColNo Column

IMPORT_C TDbColNo UserColNo(const TDbColName &aUserColName) const;

Description

Gets a column number for a named column.

Parameters

const TDbColName &aUserColName Column name

Return value

TDbColNo Column number

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

TDbColNo aUserColNo Column number const CDbColSet *aDbColSet Column definition set

Return value

TDbColNo User column number

inline const TDbColName ColName(TDbColNo aUserColNo) const;

Description

Gets the column name for a specified column number.

Parameters

TDbColNo aUserColNo Column number

Return value

const TDbColName Column name

IMPORT_C TDbColName DbColName(const TDbColName &aUserColName) const;

Description

Gets a generated UID column name for a specified column.

Parameters

const TDbColName &aUserColName Column

Return value

TDbColName Generated UID column name

IMPORT_C TDbColName DbColNameFromUId(TInt aUid) const;

Description

Gets a generated UID column name.

Parameters

TInt aUid UID

Return value

TDbColName Generated UID column name

inline const TFileName &TableName() const;

Description

Gets the table name (const overload).

Return value

const TFileName & Table name

inline const CDaUserColSet &ColSet() const;

Description

Gets the column set.

Return value

const CDaUserColSet & Column set

IMPORT_C TInt UId(TDbColNo aUserColNo) const;

Description

Gets the UID field for a column specified by number.

Parameters

TDbColNo aUserColNo Column number

Return value

TInt UID field

See also:

• TDaUserCol::iUId

IMPORT_C TInt UId(const TDesC &aColName) const;

Description

Gets the UID field for a column specified by name.

Parameters

const TDesC &aColName Column name

Return value

TInt UID field

See also:

• TDaUserCol::iUId