[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.DatabaseColumnValue


Name DatabaseColumnValue
Type Method
Summary Returns the contents of an SQL column, as text, float, integer, or null
Prototype VARIANT DatabaseColumnValue(BSTR DbName, long Column);

View list of 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.


Note: Available in version 4.40 onwards.


Lua example
x = DatabaseColumnValue ("db", 2)  --> the contents of column 2
Lua notes
Lua returns nil for a NULL value.
Returns 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.
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
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

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]