Description of MUSHclient world function: world.DatabaseStep
Name | DatabaseStep |
---|---|
Type | Method |
Summary | Executes a previously-prepared SQL statement |
Prototype | long DatabaseStep(BSTR DbName);
|
Description | Executes an SQL statement over one row over the database. In the case of a SELECT statement, one row is returned for each call to DatabaseStep. Note: Available in version 4.40 onwards. |
Lua example |
|
Lua notes |
|
Returns | 100: Another row is ready. |
Introduced in version | 4.40 |
See also ...
Function | Description |
---|---|
DatabaseColumnName | Find the name of a specified column returned by an SQL statement |
DatabaseColumnNames | Return a table of all the columns returned by an SQL statement |
DatabaseColumns | Find how many columns will be returned by an SQL statement |
DatabaseColumnText | Returns the contents of an SQL column, as text |
DatabaseColumnType | Returns the type of data in an SQL column |
DatabaseColumnValue | Returns the contents of an SQL column, as text, float, integer, or null |
DatabaseColumnValues | Returns the contents of all the SQL columns after a step |
DatabaseError | Returns an English string describing the most recent SQL error |
DatabaseExec | Executes SQL code against an SQLite database |
DatabaseFinalize | Finalizes (wraps up) a previously-prepared SQL statement |
DatabaseLastInsertRowid | Returns the most recently automatically allocated database key |
DatabaseOpen | Opens an SQLite database |
DatabasePrepare | Prepares an SQL statement for execution |
DatabaseReset | Resets a previously-prepared SQL statement to the start |
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.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise of the function.
You can view a list of the return codes
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
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.