Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.DatabaseTotalChanges


Name DatabaseTotalChanges
Type Method
Summary Returns a count of the total changes to the database
Prototype long DatabaseTotalChanges(BSTR DbName);
Description

This function returns the number of row changes caused by INSERT, UPDATE or DELETE statements since the database connection was opened. The count includes all changes from all trigger contexts. However, the count does not include changes used to implement REPLACE constraints, do rollbacks or ABORT processing, or DROP table processing. The changes are counted as soon as the statement that makes them is completed (when the statement handle is passed to DatabaseReset or DatabaseFinalize).


Note: Available in version 4.40 onwards.


Lua example
changes = DatabaseTotalChanges ("db")
Returns A positive integer, or zero, indicating the count of changes.

Otherwise:

-1 : Database id not found
-2 : Database not open
Introduced in version 4.40

See also ...

Function Description
DatabaseChanges Returns a count of the changes to the database by the most recent SQL statement
DatabaseExec Executes SQL code against an SQLite database
DatabaseLastInsertRowid Returns the most recently automatically allocated database key
DatabaseStep Executes a previously-prepared SQL statement

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.