Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.DatabaseInfo

Name DatabaseInfo
Type Method
Summary Returns information about a database
Prototype VARIANT DatabaseInfo(BSTR DbName, long InfoType);

View list of data type meanings
Description

This returns information about a particular database.

DbName - the identifying name of an existing database (as supplied to DatabaseOpen). Not the file name.

InfoType - the information you want:

1 - Name of database on disk

2 - Has a DatabasePrepare been validly done recently (and is still active)?

3 - Has a valid row been returned by DatabaseStep?

4 - Count of columns returned from the last DatabasePrepare.

Note: Available in version 4.40 onwards.
Lua example 
DatabaseInfo ("db", 4) --> get count of columns
Lua notes 
Lua returns nil instead of a NULL or EMPTY variant.
Returns The specified information about the database, as described above.
An EMPTY variant, if the database does not exist.
A NULL variant if the InfoType is not a valid type.
Introduced in version 4.40

See also ...

Function Description
DatabaseList Lists all databases

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.

Home