#include <d32dbms.h>
| class RDbUpdate |
| Public Member Functions | |
|---|---|
| IMPORT_C void | Close() |
| IMPORT_C TInt | Execute(RDbDatabase &, const TDesC &, TDbTextComparison) |
| IMPORT_C TInt | Next() |
| IMPORT_C void | Next(TRequestStatus &) |
| IMPORT_C TInt | RowCount() |
Provides an interface to allow incremental execution of a DML (SQL data update) statement.
This class offers similar behaviour to the RDbIncremental class, in that it allows an application to perform long running operations while remaining responsive to events. However, unlike that class, RDbUpdate is restricted to executing DML statements.
See also: RDbIncremental
| IMPORT_C void | Close | ( | ) |
Releases the resources used by this incremental operation object. If the operation is not yet complete, then the operation is abandoned and the database is rolled back to its state before the operation started.
| IMPORT_C TInt | Execute | ( | RDbDatabase & | aDatabase, |
| const TDesC & | aSql, | |||
| TDbTextComparison | aComparison = EDbCompareNormal | |||
| ) | ||||
Initiates the incremental execution of a DML (SQL data update) statement on the database. This is similar to RDbDatabase::Execute().
Note that to begin executing a DDL (SQL schema update) statement incrementally, use the RDbIncremental class.
See also: RDbIncremental RDbDatabase::Execute()
the schema access policy for the database, if the SQL statement is CREATE/DROP/ALTER;
the write access policy for the table in the SQL, if the SQL statement is INSERT/UPDATE/DELETE;
| Parameter | Description |
|---|---|
| aDatabase | The database on which the DML (SQL data update) statement is to execute. |
| aSql | A reference to a descriptor containing the DML statement to be executed. |
| aComparison | This argument is only used in the execution of some SQL statements. By default the comparison is EDbCompareNormal. For more information see RDbDatabase::Execute(). |
Returns: KErrNone, if the operation is complete or 1, if the operation requires further incremental execution or another of the system-wide error codes.
| IMPORT_C TInt | Next | ( | ) |
Performs the next step in the incremental execution of the DML (SQL data update) statement synchronously. The function returns when the step is complete.
Note that if the incremental step fails, then the incremental object should be closed and the operation abandoned.
Returns: KErrNone if execution of the DML statement is complete or 1 if another step in the execution of the DML statement is needed. or another of the system-wide error codes is returned if the incremental step fails.
| IMPORT_C void | Next | ( | TRequestStatus & | aStatus | ) |
Performs the next step in the incremental execution of the DML (SQL data update) statement asynchronously.
The function returns immediately and signals when the step is complete.
This function is most effectively used when the incremental operation is packaged as an active object.
Note that if the incremental step fails, then the incremental object should be closed, and the operation abandoned.
| Parameter | Description |
|---|---|
| aStatus | The request status used to contain completion information for the operation. On completion, it contains:KErrNone, if execution of the DML statement is complete or 1, if another step in the execution of the DML statement is needed. or another of the system-wide error codes, if the incremental step fails. |
| IMPORT_C TInt | RowCount | ( | ) | const |
Returns the number of rows currently affected by the execution of the DML (SQL data update) statement on the database.
Once execution of the DML statement is complete, the value returned is the final total number of rows affected.
Returns: The current/final number of rows affected by the execution of the DML statement.