tConnection

See Also: Declaring Variables, Struct

 

Purpose

tConnection is a structured type used in the cConnection class. See Managing Connection Information in the Managed Connections book for details.

 

Type Declaration

// connection ID information

Struct tConnection

    String sId

    String sString

    String sUID

    String sPWD

    Boolean bTrustedConnection

    Integer iOptions

    String sDriver

    Integer iDriverIndex

    String sConnectionString

    String sSection

    Boolean bDisabled

End_Struct

 

Struct Members

sId

Connection ID

sString

Contains all of the ODBC connection string, except for the credential information.

sUID

User ID

sPWD

Password (unencrypted)

bTrustedConnection

Use Trusted Connection?

iOptions

Connection ID options (do no use)

sDriver

Driver Name

iDriverIndex

Loaded driver index (is 1-based, 0 if none)

sConnectionString

Contains the complete ODBC connection string, including the credential information. This value is determined by calling AssembleConnectionString when a connection is registered (AddConnection) or changed (RedirectConnectionId, ChangeConnectIdCredentials). This member is the string that is used to perform a login.

sSection

You are advised against trying to use the sSection member in any meaningful way in your code.

bDisabled

If set, this is not an active ID.

 

Syntax

Use cConnection.pkg

:

tConnection {variableName}

 

Declaring variables

To declare tConnection variables, use the name of the type (tConnection) followed by the variable name.

tConnection MyConnectionData

See struct variables for more details of instantiating struct types.