#include <commdb.h>
Link against: commdb.lib
class CCommsDbTableView : public CBase |
Protected Attributes | |
---|---|
CCommsDatabaseBase & | iDb |
CCommDbTableExtension * | iTableExt |
TBuf< KCommsDbSvrMaxColumnNameLength > | iTableName |
RDbView | iTableView |
Protected Member Functions | |
---|---|
void | Close() |
TDbColNo | ColNumL(const TDesC &) |
void | ConstructL(const TDesC &, TBool, TBool) |
void | ConstructL(const TDbQuery &, TBool) |
void | ConstructL(const TDesC &, const TDesC &, const TDesC8 &) |
void | ConstructL(const TDesC &, const TDesC &, const TDesC16 &) |
void | ConstructL(const TDesC &, const TDesC &, TUint32) |
void | ConstructL(const TDesC &, const TDesC &, TBool) |
void | ConstructL(TUint32, TCommDbConnectionDirection) |
void | ConstructL(TUint32) |
void | ConstructL(TUint32, const TDesC &) |
void | ConstructL(const TDesC &) |
RDbRowSet::TAccess | GetL() |
The view on a specific table in the database.
Includes the necessary behaviour for navigating through the records in the view and reading and writing to columns within a record.
Uses a CCommsDatabase and has an RDbView to read from and write to database. Created via CCommsDatabase::OpenTableLC() (which opens a view of all the records in the table) or one of the OpenViewLC...() functions (which open a specific view of the table):
CCommsDatabase::OpenViewMatchingUintLC()
CCommsDatabase::OpenViewMatchingBoolLC()
CCommsDatabase::OpenViewMatchingTextLC()
Note that the above five functions have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
CCommsDatabaseBase & | iDb | [protected] |
CCommDbTableExtension * | iTableExt | [protected] |
TBuf< KCommsDbSvrMaxColumnNameLength > | iTableName | [protected] |
RDbView | iTableView | [protected] |
CCommsDbTableView | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName | ||
) |
Internal constructor.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database. |
aTableName | The name of the table to view. |
IMPORT_C | ~CCommsDbTableView | ( | ) | [virtual] |
Frees all resources owned by this object, prior to its destruction. Specifically, it closes the view.
IMPORT_C void | CancelRecordChanges | ( | ) |
Abandons changes made to a record which were started by calls to either:InsertRecord() or UpdateRecord().
A call to one of either InsertRecord() or UpdateRecord() must have previously been made otherwise the function raises a CommsDbServer 5 panic.
Return the column number of the Column aColumn in the table
Coloumn concept doesn't exist in CommsDat Not supported from v9.1
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
void | ConstructL | ( | const TDbQuery & | aQuery, |
TBool | aUseTemplate | |||
) | [protected] |
Prepares and evaluates the table view using the SQL query aQuery
DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.
Parameters | |
---|---|
aQuery | A reference to TDbQuery which contains the query to perform |
aUseTemplate | A boolean value whether to use template while creating the object or not |
void | ConstructL | ( | const TDesC & | aTableName, |
const TDesC & | aColumnToMatch, | |||
const TDesC8 & | aValueToMatch | |||
) | [protected] |
void | ConstructL | ( | const TDesC & | aTableName, |
const TDesC & | aColumnToMatch, | |||
const TDesC16 & | aValueToMatch | |||
) | [protected] |
void | ConstructL | ( | const TDesC & | aTableName, |
const TDesC & | aColumnToMatch, | |||
TUint32 | aValueToMatch | |||
) | [protected] |
void | ConstructL | ( | const TDesC & | aTableName, |
const TDesC & | aColumnToMatch, | |||
TBool | aValueToMatch | |||
) | [protected] |
void | ConstructL | ( | TUint32 | aBearerSet, |
TCommDbConnectionDirection | aDirection | |||
) | [protected] |
void | ConstructL | ( | TUint32 | aNetworkId | ) | [protected] |
CCommsDatabaseBase * | Database | ( | ) | const [inline] |
IMPORT_C TInt | DeleteRecord | ( | ) |
Deletes the record in the table at the current cursor position.
This function raises a CommsDbServer 3 panic if a previous call to InsertRecord() or UpdateRecord() has been made.
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
RDbRowSet::TAccess | GetL | ( | ) | [protected] |
Gets the operations that can be performed on the current view
void | GetTableName | ( | TDes & | aTableName | ) | const [inline] |
Gets the name of the table associated with this view and copies it into the descriptor supplied by the caller.
Parameters | |
---|---|
aTableName | A reference to a descriptor passed by the caller. On return from this function it contains the name of the table. |
IMPORT_C TInt | GotoFirstRecord | ( | ) |
Sets the first record in the view as the current record; i.e. set the view's cursor to point to the first record.
The CommsDbServer 6 panic is also raised if this function is called after the view has been closed.
This function must not be called if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 6 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
IMPORT_C TInt | GotoNextRecord | ( | ) |
Sets the next record in the view as the current record; i.e. set the view's cursor to point to the next record.
This function must not be called if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 7 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
The CommsDbServer 7 panic is also raised if this function is called after the view has been closed.
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
IMPORT_C TInt | GotoPreviousRecord | ( | ) |
Sets the previous record in the view as the current record; i.e. set the view's cursor to point to the previous record.
This function must not be called if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 8 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
The CommsDbServer 8 panic is also raised if this function is called after the view has been closed.
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Add a new record to this table. Filling all empty fields with values copied from record currently pointed at. The record number is returned. `PutRecordChanges()` is called to complete the transaction
Inserts a row into the the table and writes the {incremented) id to aId Filling all empty fields with values copied from record currently pointed at. The record number is returned.
Parameters | |
---|---|
aId | On return contains the unique Id associated with this new record. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Prepares database to insert a new record and returns a unique ID for the record to be added.
PutRecordChanges() must be called to add the new entry.
This function sets the CCommsDbTableView onto the new record.
Once all changes to the new record are complete, a call must be made to either PutRecordChanges() or CancelRecordChanges() as appropriate.
This function raises a CommsDbServer 1 panic if a previous call to InsertRecord() or UpdateRecord() has already been made.
This function must be called before any attempt is made to write to a new column, otherwise subsequent write operations raise a CommsDbServer 12 panic.
Once this function has completed successfully, no attempt can be made to read from a column until either PutRecordChanges() or CancelRecordChanges() has been called to complete the record insertion operation, otherwise the read operations raise a CommsDbServer 10 panic.
Parameters | |
---|---|
aId | On successful return, contains the unique Id associated with the new record. |
CCommsDbTableView * | NewL | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName, | |||
const TDbQuery & | aQuery, | |||
TBool | aUseTemplate = ETrue | |||
) | [static] |
Internal low level view creation.
Not in use after shim is introduced
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
aTableName | Name of the table of view. |
aQuery | Query to perform. |
aUseTemplate | Use the template values from the database - defaults to ETrue. |
CCommsDbTableView * | NewL | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName, | |||
const TDesC & | aColumnToMatch, | |||
const TDesC8 & | aValueToMatch | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
aTableName | Name of the table of view. |
CCommsDbTableView * | NewL | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName, | |||
const TDesC & | aColumnToMatch, | |||
const TDesC16 & | aValueToMatch | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
aTableName | Name of the table of view. |
CCommsDbTableView * | NewL | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName, | |||
const TDesC & | aColumnToMatch, | |||
TUint32 | aValueToMatch | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
aTableName | Name of the table of view. |
CCommsDbTableView * | NewLC | ( | const TDesC & | aTableName, |
CCommsDatabaseBase & | aDb | |||
) | [static] |
Internal low level view creation.
Used only if is called from TemplateRecord class
Parameters | |
---|---|
aTableName | Name of the table of view. |
aDb | Reference to the instance of the Comms Database to use. |
CCommsDbTableView * | NewLC | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName, | |||
TBool | aUseTamplate = ETrue | |||
) | [static] |
Internal low level view creation.
Internal use as replacement for SQL queries. Introduced with commdb shim
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
aTableName | Name of the table of view. |
CCommsDbTableView * | NewLC | ( | CCommsDatabaseBase & | aDb, |
const TDesC & | aTableName, | |||
const TDesC & | aColumnToMatch, | |||
TBool | aValueToMatch | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
aTableName | Name of the table of view. |
CCommsDbTableView * | NewLC | ( | CCommsDatabaseBase & | aDb, |
TUint32 | aBearerSet, | |||
TCommDbConnectionDirection | aDirection | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
CCommsDbTableView * | NewLC | ( | CCommsDatabaseBase & | aDb, |
TUint32 | aNetworkId | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
CCommsDbTableView * | NewLC | ( | CCommsDatabaseBase & | aDb, |
TUint32 | aServiceId, | |||
const TDesC & | aServiceType | |||
) | [static] |
Internal low level view creation.
Use if CCommsDatabase::OpenTableLC() or CCommsDatabase::OpenViewLC...() are not sufficient.
Note that OpenTableLC() and OpenViewLC...() have been withdrawn in CCommsDatabase and are now implemented in CCommsDatabaseBase.
Parameters | |
---|---|
aDb | Reference to the instance of the Comms Database to use. |
void | OpenL | ( | const TDbQuery & | aQuery | ) |
DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.
Parameters | |
---|---|
aQuery | A reference to TDbQuery which contains the query to perform |
Confirms changes made to a record, which were started by calls to one of InsertRecord() or UpdateRecord().
The record can be marked as hidden by passing ETrue as a parameter. By default, records are not hidden.
A call to one of either InsertRecord() or UpdateRecord() must have previously been made otherwise the function raises a CommsDbServer 4 panic.
Parameters | |
---|---|
aHidden | Defines whether or not the record is to be marked as hidden. A true value means that the record is to be hidden. If not explicitly specified, EFalse is taken as default. |
aReadOnly | Defines whether or not the record is to be stored as read-only. Read-only storage prevents the record from being altered at a later time. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Reads a boolean value located in a specific column within the current record and copies it into a specified value. The column is identified by the name supplied in the descriptor aColumn.
If the column in the current record has a NULL value and the table has a template record, then the value located in the corresponding column in that template record is read and copied into aValue.
If the column in the current record has a NULL value and the table does not have a template record, then the function leaves.
This read operation must not occur if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of the column in the current record whose (boolean) value is to be read. |
aValue | A reference to a TBool passed by the caller. |
Leave Codes | |
---|---|
KErrUnknown | if the specified column is null; KErrNotFound if the specified column does not exist in the table. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Gets the length of a specific column within the current record and copies it into a reference to an integer. The column is identified by the name supplied in the descriptor aColumn.
If the length of the column is zero and the table has a template record, then the length of the corresponding column in that template record is copied into aValue.
Null columns return 0; integers and bools return 1; strings return their length in characters.
This read operation must not occur if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aLength | A reference to an integer passed by the caller. On successful return from this function, contains a copy of the length of the column. |
Leave Codes | |
---|---|
KErrNotFound | Specified column does not exist in the table. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Reads the MAXIMUM length of the contents of aColumn from the current record into aLength
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aLength | A reference to an integer passed by the caller. On successful return from this function, contains a copy of the length of the column. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Reads the long text located in a specific column within the current record and copies this text to a heap descriptor. The heap descriptor is allocated and its pointer returned by this function. The column is identified by the name supplied in the descriptor aColumn.
If the column in the current record has a NULL value and the table has a template record, then the long text located in the corresponding column in that template record is read and copied.
If the column in the current record has a NULL value and the table does not have a template record, then the length of the returned heap descriptor is zero and the descriptor contains no text.
While the text in columns retrieved by the ReadTextL() functions is limited in length, there is no restriction on the length of long text.
The HBufC* returned is left on the cleanup stack. The caller is responsible for calling CleanupStack::PopAndDestroy().
This read operation must not occur if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
Leave Codes | |
---|---|
KErrNotFound | if the specified column does not exist in the table; KErrNoMemory if out of memory. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Reads narrow (ASCII) text located in a specific column within the current record and copies it into an 8 bit modifiable descriptor. The column is identified by the name supplied in the descriptor aColumn.
If the column in the current record has a NULL value and the table has a template record, then the text located in the corresponding column in that template record is read and copied into aValue.
If the column in the current record has a NULL value and the table does not have a template record, then the length of the descriptor aValue is set to zero and the descriptor contains no text.
The maximum length of text expected by this function is the value of the constant KCommsDbSvrMaxColumnNameLength. The maximum length of aValue supplied by the caller can, therefore, be the same.
This read operation must not occur if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
If the column to be read is encrypted then the function decrypts it.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of the column in the current record whose (narrow text) value is to be read. |
aValue | A reference to an 8 bit descriptor passed by the caller. |
Leave Codes | |
---|---|
KErrNotFound | Specified column does not exist in the table. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Reads wide (Unicode) text located in a specific column within the current record and copies it into a 16 bit modifiable descriptor. The column is identified by the name supplied in the descriptor aColumn.
If the column in the current record has a NULL value and the table has a template record, then the text located in the corresponding column in that template record is read and copied into aValue.
If the column in the current record has a NULL value and the table does not have a template record, then the length of the descriptor aValue is set to zero and the descriptor contains no text.
The maximum length of text expected by this function is the value of the constant KCommsDbSvrMaxColumnNameLength. The maximum length of aValue supplied by the caller can, therefore, be the same.
This read operation must not occur if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
If the column to be read is encrypted then the function decrypts it.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of the column in the current record whose (wide text) value is to be read. |
aValue | A reference to a 16 bit descriptor passed by the caller. |
Leave Codes | |
---|---|
KErrNotFound | Specified column does not exist in the table |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
IMPORT_C void | ReadTypeAttribL | ( | const TDesC & | aColumn, |
TDbColType & | aColType, | |||
TUint32 & | aAttrib | |||
) |
Gets the type and the attributes of a specific column within the current record and puts them into a TDbColType object and a reference to an unsigned integer respectively. The column is identified by the name supplied in the descriptor aColumn.
The column attributes are one or more of the values TDbCol::ENotNull and TDbCol::EAutoIncrement.
From v9.1 COMMDB_ID doesn't exist. Bacause of BC it is neccessary to return expected values
This function must not be called if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of the column in the current record whose type and attributes are to be fetched. |
aColType | A reference to a TDbColType object passed by the caller. On successful return from this function, contains a copy of the column type. |
aAttrib | A reference to an unsigned integer passed by the caller. On successful return from this function, contains a copy of the column attributes. |
Leave Codes | |
---|---|
KErrNotFound | Specified column does not exist in the table |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Reads an unsigned integer value located in a specific column within the current record and copies it into a reference to an unsigned integer. The column is identified by the name supplied in the descriptor aColumn.
If the column in the current record has a NULL value and the table has a template record, then the unsigned integer value located in the corresponding column in that template record is read and copied into aValue.
If the column in the current record has a NULL value and the table does not have a template record, then the function leaves.
This read operation must not occur if any of the operations involved in inserting or updating a record are still outstanding, otherwise the function raises a CommsDbServer 10 panic. For example, the panic is raised if this function is called between calls to UpdateRecord() and PutRecordChanges().
This panic is also raised if this function is called after the view has been closed.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of the column in the current record whose (unsigned integer) value is to be read. |
aValue | A reference to an unsigned integer passed by the caller. |
Leave Codes | |
---|---|
KErrUnknown | if the specified column is null; KErrNotFound if the specified column does not exist in the table. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
IMPORT_C void | SetNullL | ( | const TDesC & | aColumn | ) |
Sets a specific column within the current record to NULL. For text type columns, this is the same as setting the column to an empty string. The column is identified by the name supplied in the descriptor aColumn.
An earlier call to either UpdateRecord() or InsertRecord() must have been made before calling this function otherwise the function raises a CommsDbServer 12 panic. This panic is also raised if this function is called after the view has been closed.
PutRecordChanges() must be called to store the changes.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
IMPORT_C TInt | UpdateRecord | ( | ) |
Modify the current record of this view. `PutRecordChanges()` is called to complete the transaction
Prepares to update the current record PutRecordChanges() must be called before editing any existing column.
Once all changes to the new record are complete, a call must be made to either PutRecordChanges() or CancelRecordChanges() as appropriate.
This function raises a CommsDbServer 2 panic if a previous call to InsertRecord() or UpdateRecord() has already been made.
This function must be called before any attempt is made before editing any existing column otherwise subsequent write operations raise a CommsDbServer 12 panic.
Once this function has completed successfully, no attempt can be made to read from a column until either PutRecordChanges() or CancelRecordChanges() has been called to complete the record insertion operation, otherwise the read operations raise a CommsDbServer 10 panic.
Writes a Boolean value to a specific column within the current record. The column is identified by the name supplied in the descriptor aColumn.
An earlier call to either UpdateRecord() or InsertRecord() must have been made before calling this function otherwise the function raises a CommsDbServer 12 panic. If the column identified is the COMMDB_ID field, than this function raises a CommsDbServer 13 panic. This panic is also raised if this function is called after the view has been closed.
PutRecordChanges() must be called to store the changes.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aValue | A reference to TBool containing the value to be written into the column. |
Leave Codes | |
---|---|
KErrNotFound | The column name does not exist. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Writes the long text from a descriptor to a specific column within the current record. The column is identified by the name supplied in the descriptor aColumn.
An earlier call to either UpdateRecord() or InsertRecord() must have been made before calling this function otherwise the function raises a CommsDbServer 12 panic. If the column identified is the COMMDB_ID field, than this function raises a CommsDbServer 13 panic. This panic is also raised if this function is called after the view has been closed.
PutRecordChanges() must be called to store the changes.
While the text written by WriteTextL() functions is limited in length, there is no restriction on the length of long text.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aValue | A reference to a descriptor containing the long text to be written into the column. |
Leave Codes | |
---|---|
KErrNotFound | The column name does not exist. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Writes the narrow (ASCII) text from an 8 bit descriptor to a specific column within the current record. The column is identified by the name supplied in the descriptor aColumn. The length of the text cannot be greater than the value of the constant KCommsDbSvrMaxColumnNameLength, otherwise the function leaves.
An earlier call to either UpdateRecord() or InsertRecord() must have been made before calling this function otherwise the function raises a CommsDbServer 12 panic. If the column identified is the COMMDB_ID field, than this function raises a CommsDbServer 13 panic.
PutRecordChanges() must be called to store the changes.
If the column to be read is encrypted then the function decrypts it.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aValue | A reference to an 8 bit descriptor containing the narrow text to be written into the column. |
Leave Codes | |
---|---|
KErrOverflow | The function can leave for reasons defined by DBMS but it also leaves with KErrOverflow if the length of the text is greater than the maximum permitted. |
KErrNotFound | The column name does not exist. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Writes the wide (UNICODE) text from a 16 bit descriptor to a specific column within the current record. The column is identified by the name supplied in the descriptor aColumn. The length of the text cannot be greater than the value of the constant KCommsDbSvrMaxColumnNameLength, otherwise the function leaves.
An earlier call to either UpdateRecord() or InsertRecord() must have been made before calling this function otherwise the function raises a CommsDbServer 12 panic. If the column identified is the COMMDB_ID field, than this function raises a CommsDbServer 13 panic. This panic is also raised if this function is called after the view has been closed.
PutRecordChanges() must be called to store the changes.
If the column to be read is encrypted then the function decrypts it.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aValue | A reference to a 16 bit descriptor containing the wide text to be written into the column. |
Leave Codes | |
---|---|
The | function can leave for reasons defined by DBMS but also leaves with KErrOverflow if the length of the text is greater than the maximum permitted or KErrNotFound if the column name does not exist. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |
Writes an unsigned integer value to a specific column within the current record. The column is identified by the name supplied in the descriptor aColumn.
An earlier call to either UpdateRecord() or InsertRecord() must have been made before calling this function otherwise the function raises a CommsDbServer 12 panic. If the column identified is the COMMDB_ID field, than this function raises a CommsDbServer 13 panic. This panic is also raised if this function is called after the view has been closed.
PutRecordChanges() must be called to store the changes.
Parameters | |
---|---|
aColumn | A reference to a descriptor containing the name of a column in the current record. |
aValue | A reference to an unsigned integer containing the value to be written into the column. |
Leave Codes | |
---|---|
KErrNotFound | The column name does not exist. |
Capability | |
---|---|
Dependent | on table, see the guide page referenced below. |