4.2. Database Connection Status Functions

The following functions provide details about an existing connection object.

FQstatus

Determines whether the provided connection object has an active connection.

FBconnStatusType FQstatus(FBconn *conn);

Returns one of:

  • CONNECTION_OK
  • CONNECTION_BAD
FQdb_path

Returns the path of the database for the current connection.

const char *FQdb_path(const FBconn *conn);

FQuname

Returns the username for the current connection.

const char *FQuname(const FBconn *conn);

FQupass

Returns the password for the current connection.

const char *FQupass(const FBconn *conn);

FQparameterStatus

Looks up a current parameter setting of the connection.

const char *FQparameterStatus(const FBconn *conn, const char *paramName);

Currently the only supported parameters are:

  • client_encoding
  • time_zone_names

Other parameters may be added at a future date.

FQclientEncodingId

Returns the ID of the current client encoding (or -1 if unknown).

int FQclientEncodingId(FBconn *conn);

FQlibVersion

Returns the integer value for the libfq version with which the current connection is being made.

int FQlibVersion(void);

FQlibVersionString

Returns the string value for the libfq version with which the current connection is being made.

char *FQlibVersionString(void);

FQserverVersion

Returns the server version represented as an integer.

int FQserverVersion(FBconn *conn);

The integer is formed by multiplying the server's major version number by 10000, the secondary version number by 100 and adding the tertiary version number. For example, Firebird 2.5.8 becomes 20508, and Firebird 3.0.3 becomes 30003.

FQserverVersionString

Returns the server version in string form.

char *FQserverVersionString(FBconn *conn);