world.DatabaseColumnValue

MUSHclient script function (Method) — introduced in version 4.40

Returns the contents of an SQL column, as text, float, integer, or null

Prototype

VARIANT DatabaseColumnValue(BSTR DbName, long Column);

Data type meanings

Description

You can use this, after successfully doing a DatabaseStep, to get the data in a particular column, in the appropriate format: text, floating point number, integer or null.

Columns start at 1 for the first column, up to the number returned by DatabaseColumns.

Lua example

x = DatabaseColumnValue ("db", 2)  --> the contents of column 2

Lua notes

Lua returns nil for a NULL value.

Return value

The contents of the column, as a string, long, double or empty variant.

Returns the null variant if there is an error, such as invalid database id, no current row, etc.

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
DatabaseColumnValuesReturns the contents of all the SQL columns after a step
DatabaseColumnsFind how many columns will be returned by an SQL statement
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