dbGetConnectOptions#

Purpose#

Returns the connection options string used for a database connection.

Format#

options = dbGetConnectOptions(db_id)#
Parameters:

db_id (scalar) – database connection index number.

Returns:

options (string) – Contains the connection options for the specified database connection.

Remarks#

If you have not set any connection options with dbSetConnectOptions(), then this function will return an empty string. For a full list of options see dbSetConnectOptions().

Examples#

// Add MySQL to the list of database connections
db_id = dbAddDatabase("MYSQL");

// Retrieve the current connection options
opts = dbGetConnectOptions(db_id);

// Print the options string
print opts;