dca_interface  6.3.4
dca::DbConnectionData Struct Reference

#include <base_classes.h>

Detailed Description

Stores the connection data for a database.

This structure is used to create a DbConnection.

To setup a database connection set the related dbType either to DBT_Url, DBT_Mail or DBT_Custom.

Databases of type DBT_Url can be either local or remote. When using a remote DBT_Url database you will also need to setup the remoteServerData members.

Databases of type DBT_Mail only support local DbConnections. The localData structure members must also be setup.

Databases of type DBT_Custom only support local DbConnections. The customData structure members must also be setup.

See also
DbConnection, DbConnectionRemoteServerData

Definition at line 815 of file base_classes.h.

Public Attributes

DbType dbType
 The type of the database.
 
bool useLocalDatabase
 Set to true to connect to a local or custom database, set to false to use a remote database.
 
DbConnectionLocalData localData
 Fill out this structure only if you are using a local (non-custom) database.
 
DbConnectionCustomData customData
 Fill out this structure only if you are using a custom database.
 
DbConnectionRemoteServerData remoteServerData
 If you are creating a remote database connection, this structure must be filled out with the encryption data that is part of your license.
 

The documentation for this struct was generated from the following file: