DBPARAM function

Returns, as a character string, a comma-separated list of the parameters used to connect to the database.

Syntax


DBPARAM ( `integer-expression` \| `logical-name` \| `alias` )

integer-expression

The sequence number of a database the ABL session is connected to. For example, DBPARAM(1) returns information on the first database the ABL session is connected to, DBPARAM(2) returns information on the second database the ABL session is connected to, etc. If you specify a sequence number that does not correspond to a database the ABL session is connected to, the DBPARAM function returns the Unknown value (?).

logical-name or alias

These forms of the DBPARAM function require a character expression as a parameter. An unquoted character string is not permitted. If the parameter is an alias or the logical name of a connected database, then the AVM returns the comma-separated parameter list. Otherwise, it returns the Unknown value (?).

Notes

A database must be connected for the DBPARAM function to work as described.

If the CONNECT statement does not contain a -db (database) parameter, which is permissible, the string DBPARAM returns includes the -db parameter and the database name.

If the CONNECT statement contains the -pf parameter, which refers to a parameter file, the string DBPARAM returns includes the parameters in the file without “-pf” or any reference to the file.

If the CONNECT statement contains a userid and a password, the string DBPARAM returns includes only the userid.

The database can connect through the CONNECT statement, the command line, or an auto-connection.