Apollo VCL Components > Apollo VCL Component Reference > TApolloConnection

$image\TAPOLLOCONNECTION.gif$

The TApolloConnection component provides a link between TApolloTable, TApolloQuery, and TApolloSserverDLL in client applications to the Apollo Database Server application. This connection is established through the IP address (or domain name) and Port number where the server is located.

The TApolloConnection component is also used to connect TApolloQuery to the Apollo SQL add-in to execute SQL queries on local data. The Host, Port, and Active properties are not used when connecting to Apollo SQL with TApolloQuery (with AccessMethod set to amLocal).

The Apollo Database Server and Apollo SQL add-in are sold separately from Apollo VCL. Contact Vista Software or an authorized Apollo dealer for pricing and additional information.

Properties	Description
ActiveTApolloConnection_Active	Sets or breaks a connection with an Apollo Database Server.
DatabaseNameTApolloConnection_DatabaseName	Name of the active database name alias.
Host	Remote server machine's IP address or domain name.
PasswordTApolloConnection_Password	User's Password. Used with User name to log into remote server.
Port	Port number of Host to connect to.
User	User's account name. Used with Password to log into remote server.
VersionTApolloConnection_Version	Version string for TApolloConnection component.

Methods	Description
CloseDataSetsTApolloConnection_CloseDataSets	Closes all TApolloTable components attached to this TApolloConnection.
Connect	Attempts to connect the client to the server at the location specified by the Host and Port properties and fires the OnConnect event.
Connected	Returns the most recent connected status, but does not retest the connection.
DeleteFile	Deletes the specified file from the remote server.
Disconnect	Disconnect the client from the server.
FileExists	Returns True if specified file exists on the remote server, False if not.
FileIsInUse	Returns True if the specified file is in use on the remote server, False if not.
FileLength	Returns the length of the specified remote file.
FileReceive	Transfers a file (any file) from the remote server to the client.
FileSend	Transfers a file (any file) from the client to the remote server.
GetConnectionID	Returns the connection ID for the current User. A single user can have multiple connections to a server.
GetDatabaseNames	Returns a pointer to an array of names for the available database aliases on the server at the currently selected Host address and Port number
GetDatabaseNamesList	Returns a TStringList filled with the names of the available database aliases on the server at the currently selected Host address and Port number.
GetTableNames	Returns a pointer to an array of table names for the available database aliases in the active database.
GetTableNamesList	Returns a TStringList filled with the names of the available tables on the server in the specified database.
GetUserNamesList	Returns a TStringList filled with the names of currently connected users.
GetServerDateTime	Returns the current date/time of the remote server machine.
Login	Attempts to log in the client using the values specified by the User and Password properties.
Logout	Logs the client out of the server, but does not disconnect.
OpenDataSetsTApolloConnection_OpenDataSets	Opens all TApolloTable components attached to this TApolloConnection.
Ping	Tests the TCP/IP connection to the IP address (or domain name) and Port address
ServerName	Returns the name of the remote server.

Events	Description
OnError	Fires if an error occurs communicating with the server.
OnLogin	Fires when the Login method is called
OnLogout	Fires when the Logout method is called.
OnReadProgress	Fires as each 8k buffer full of data is read from the server.
OnServerProgress	Fires as the server processes the SQL expression and prepares the result set.
OnStatus	Fires as status messages are sent from the server to the client.
OnWriteProgress	Fires as each 8k buffer full of data is written to the server.