world.DatabaseColumns

MUSHclient script function (Method) — introduced in version 4.40

Find how many columns will be returned by an SQL statement

Prototype

long DatabaseColumns(BSTR DbName);

Data type meanings

Description

You can use this, after successfully doing a DatabasePrepare, to find the number of columns that each row will return. This number might be zero for SQL statements that do not return any data.

You can do this before doing a DatabaseStep, because the column names (and number of columns) is a property of the SQL statement, whether or not any rows are found that actually match the query.

Lua example

columns = DatabaseColumns ("db")

Return value

A positive integer, or zero, representing the number of columns that the prepared SQL statement will return.

Otherwise, an error code:

-1 : Database id not found
-2 : Database not open
-4 : Do not have prepared statement

Related topic

Database (SQLite)

See also

FunctionDescription
DatabaseColumnNameFind the name of a specified column returned by an SQL statement
DatabaseColumnNamesReturn a table of all the columns returned by an SQL statement
DatabaseColumnTextReturns the contents of an SQL column, as text
DatabaseColumnTypeReturns the type of data in an SQL column
DatabaseColumnValueReturns the contents of an SQL column, as text, float, integer, or null
DatabaseColumnValuesReturns the contents of all the SQL columns after a step
DatabaseErrorReturns an English string describing the most recent SQL error
DatabaseExecExecutes SQL code against an SQLite database
DatabaseFinalizeFinalizes (wraps up) a previously-prepared SQL statement
DatabaseLastInsertRowidReturns the most recently automatically allocated database key
DatabaseOpenOpens an SQLite database
DatabasePreparePrepares an SQL statement for execution
DatabaseResetResets a previously-prepared SQL statement to the start