19.2.5 a_rdb_SQLFreeConnect() (release a connection handle)

(1) Function

This CLI function releases the connection handle for a closed connection.

To Page Top

(2) Format

signed short a_rdb_SQLFreeConnect
(
  void                          *ConnectionHandle,   /* In */
  void                          *Option              /* In */
)

To Page Top

(3) Arguments

ConnectionHandle

Specifies a connection handle.

Option

Specifies NULL.

To Page Top

(4) Return value

1. If a_rdb_SQLFreeConnect() terminates normally, a_rdb_RC_SQL_SUCCESS is returned.

2. If the connection handle is released successfully, but the disk containing client message log files has become full, a_rdb_RC_SQL_WARNING is returned.

3. If an error occurs while messages cannot be output to the client message log file, the error cause code is returned. For details about the error cause code, see 19.8 Return values of the CLI functions.

To Page Top

(5) Notes

If a_rdb_SQLFreeConnect() is executed without a_rdb_SQLDisconnect() having been executed, processing equivalent to a_rdb_SQLDisconnect() is performed as an extension of a_rdb_SQLFreeConnect(), and then the connection handle is released.

To Page Top