Skip to content

Methods for cConnection

View method list in hierarchical order.

Name Type Description Defining Class
AddAllConnections Function Reads all connections and registers all active connections AddAllConnections reads all connections and registers all active connections. cConnection
AddConnection Function Registers and adds a Connection ID for the driver AddConnection registers and adds a Connection ID for the driver. cConnection
AssembleConnectionString Function Helper function that assembles a complete ODBC Server String from components passed in cConnection
AutoConnect Procedure Registers all connections by sending RegisterAllConnections and logs in to all connections by sending LoginAll cConnection
AutoDisconnect Procedure Disconnects and unregsters all connections when a workspace is opened Disconnects and unregsters all connections when a workspace is opened. cConnection
ChangeConnectIdCredentials Function Changes login credentials for a Connection ID ChangeConnectIdCredentials logs out and disconnect from the existing connection and connect (but not login) to the new one. cConnection
CheckTokenConnection Procedure cConnection
ChildByIndex Function Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. cObject
ClassSuperClass Function Returns the superclass of the passed class This returns the superclass of the passed class. cObject
ConfigurationError Procedure Sent when a configuration error occurs When a configuration error occurs the ConfigurationError message is sent. cConnection
ConnectionDatabaseIdHandle Function Returns handle to the database for the passed in connection If you wish to communicate with the database API interface, you need to use the iDriverIndex member and a database Id handle. cConnection
ConnectionIdCLIHandler Function Returns a handle for the CLI object associated with the passed Connection ID, tests if Connection ID is registered Returns a handle for the CLI object associated with the passed Connection ID. cConnection
ConnectionIdIndex Function Returns the index for the passed Connection ID within the internal array of connections described in ConnectionIDs, tests if Connection ID is registered cConnection
ConnectionIdInfo Function Returns complete and up to date information for a registered connection ConnectionIdInfo returns complete and up to date information for a registered connection. cConnection
ConnectionIDs Function Array of registered Connection IDs The cConnection object maintains a list of all registered Connection IDs in an array of tConnection items. cConnection
ConnectionIDServerString Function Returns the Connection Id syntax used for IDs in the INT file cConnection
ConnectionIniFile Function Returns the full path name of the Connection INI file This returns the full path name of the Connection INI file. cConnection
ConnectionIniFromCmdLine Function Returns Connection.Ini file name if it was passed into the application on the command line Returns Connection.Ini file name if it was passed into the application on the command line. cConnection
Create Function Creates an object based on the passed Class Id The Create function is used to dynamically create objects. cObject
CreateESQLConnectionHandler Function Creates an SQL Connection Handler Creates an SQL Connection handler. cConnection
CreateNamed Function Creates an object based on the passed Class Id and assigns it a name Name based on a passed name Creates an object based on the passed Class Id and assigns it a name Name based on a passed name. cObject
DecryptPassword Function Used to decrypt a password DecryptPassword is used to decrypt a password. cConnection
DeleteConnectionId Procedure Removes a registered connection for a passed Connection ID This removes a registered connection for a passed Connection ID parameter. cConnection
Destroy Procedure Destroys the object that receives the message and any child objects of that object The Destroy message destroys the object that receives the message. cObject
DriverCLIHandler Function Returns a handle for the CLI object associated with the passed driver, tests if driver is registered This returns a handle for the CLI object associated with the passed driver. cConnection
DriverIndex Function Returns the index for a loaded driver Driver Index returns the index for a loaded driver. cConnection
DriverServerNames Function Returns an array of logged in servers for the passed driver DriverServerNames returns an array of logged in servers for the passed driver. cConnection
EncryptPassword Function Used to encrypt a password EncryptPassword is used to encrypt a password. cConnection
EnumerateConnections Procedure Lists the currently registered Connection Ids EnumerateConnections lists the currently registered Connection Ids. cConnection
Exit_Application Procedure Starts the process of closing an application The Exit_Application message is used to close the program. cObject
IsClassOfClass Function Determines whether the target class is part of the searched class's hierarchy cObject
IsConnectionIdLoggedIn Function Tests if the connection identified by the passed connection Id is logged in to database server This tests if the connection identified by the passed connection Id is logged in to database server. cConnection
IsManagedConnection Function Used to check if a table uses managed connection Checks if the table passed as parameter (hTableNumber) uses managed  connection. cConnection
IsObjectOfClass Function Determines whether the passed class is part of the object's class hierarchy This returns True if the passed class is part of the object's class hierarchy. cObject
LoadedDrivers Function Returns a string array of all loaded drivers, both managed and unmanaged LoadedDrivers returns a string array of all loaded drivers both managed and unmanaged. cConnection
LoadStoredConnections Function Used to read the connections INI file LoadStoredConnections is used to read the connections INI file. cConnection
LoginAll Procedure Logs in to all managed connections LoginAll logs in to all Managed Connections. cConnection
LoginAllConnections Function Attempts to log in to all managed connections LoginAllConnections is a function that attempts to log in to all Managed Connections. cConnection
LoginConnectIdBase Function Attempts the actual login LoginConnectIdBase attempts the actual login. cConnection
LoginConnectIdDialog Function Pops up a database login dialog, which will allow the user to log in and store the login credentials cConnection
LoginConnectIdNewCredentials Function Attempts a Connection Id login using Id with passed credentials LoginConnectIdNewCredentials attempts a Connection Id login using Id with passed credentials. cConnection
LoginConnectionId Function Attempts to log in the connection identified by the passed connection ID LoginConnectionId attempts to log in the connection identified by the passed connection ID. cConnection
LoginServer Function Login to this Managed Connection via a Driver and Connection String LoginServer logs in to this Managed Connection via a Driver and Connection String. cConnection
LogoutAllConnections Procedure Performs a log out of all connections This performs a log out of all connections. cConnection
LogoutConnectionId Procedure Performs a log out for a passed Connection ID This performs a log out for a passed Connection ID parameter. cConnection
ObjectClass Function Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. cObject
RedirectConnectionId Function Redirects a connection from one Server String to another without closing any tables Redirects a connection from one Server String to another without closing any tables. cConnection
RegisterAllConnections Procedure Reads all connections and registers all active connections RegisterAllConnections reads all connections and registers all active connections. cConnection
RegisterDriver Function Used to load and register managed drivers RegisterDriver is used to load and register managed drivers. cConnection
Request_Destroy_Object Procedure Use the Destroy method instead This method is used to destroy an object and all of its children. cObject
SetTokenConnection Procedure cConnection
SQLConnectionByTable Function Returns a connection handle for the connection being used by an open table Returns a connection handle for the connection being used by an open table. cConnection
SQLConnectionId Function Returns an SQL connection handle Once a connection is created and logged into, you may obtain an SQL connection handle by calling SQLConnectionId, passing the connection ID. cConnection
StoreConnectionIdCredentials Function Used to store login credentials (user name, password and trusted-connection) in the connections INI file cConnection
TableConnectionID Function Returns the connection ID of a table if the table uses managed connection cConnection
TestDriverConformance Function Used to test of the driver can be used as a managed driver This is called right after a driver loaded but before it is registered. cConnection
TrapErrors Procedure Starts error trapping TrapErrors starts error trapping. cConnection
UnRegisterAllConnections Procedure Removes all registered Connection IDs This removes all registered Connection IDs. cConnection
UnTrapErrors Procedure Stops error trapping and errors are now redirected to the standard error handler cConnection