Skip to content

ConnectionIdInfo - cConnection

Returns complete and up to date information for a registered connection

Type: Function
Return Data Type: tConnection

Parameters

Parameter Type Description
sId String Connection ID

Syntax

Function ConnectionIdInfo String sId Returns tConnection

Call Example

Get ConnectionIdInfo sId to tConnectionVariable

Description

ConnectionIdInfo returns complete and up to date information for a registered connection. The passed connection Id is used to find the connection and returns its data in a tConnection variable.

If the connection Id does not exist, a programming error is raised.

The connection information returned may or may not be logged in. You can use IsConnectionIdLoggedIn to determine that.

The iDriverIndex member can be used to communicate with the driver API interface. The DF_DRIVER_xxx API interfaces require that you pass a driver number. DriverIndex returns that number.

If you wish to communicate with the database API interface, you need to use the iDriverIndex member and a Database Id handle. This handle can be obtained by calling ConnectionDatabaseIdHandle, passing the tConnection data returned by ConnectionIdInfo.

Return Value

Complete and up to date information for a registered connection