Unit 'SQLDB' Package
[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] [#fcl]

TSQLConnection.Connected

Is a connection to the server active or not.

Declaration

Source position: sqldb.pp line 306

published property TSQLConnection.Connected : Boolean;

Description

Connected indicates whether a connection to the server is active or not. No queries to this server can be activated as long as the value is False

Setting the property to True will attempt a connection to the database DatabaseName on host HostName using the credentials specified in UserName and Password. If the connection or authentication fails, an exception is raised. This has the same effect as calling Open.

Setting the property to False will close the connection to the database. All datasets connected to the database will be closed, all transactions will be closed as well. This has the same effect as calling Close

See also

TSQLConnection.Password

  

Password used when authenticating on the database server.

TSQLConnection.UserName

  

The username for authentication on the database server.

TSQLConnection.DatabaseName

  

The name of the database to which connection is required.

TSQLConnection.Role

  

Role in which the user is connecting to the database.


Documentation generated on: Jul 24 2023