Connection (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / Types of HFSQL variables

WLanguage properties that can be used with a connection described programmatically
Oracle Native Connector: external authentication management
Code equivalents: Description of a connection
Code equivalents: Opening a connection
Code equivalence: Assign a connection
Code equivalence: Modifying an existing connection

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Connection (Variable type)

In french: Connexion

The type Connection is used to programmatically describe one or more connections to external databases (HFSQL Client/Server, Native Connector, etc.). Then, this connection can be opened with HOpenConnection. You can define and change the characteristics of this connection using several WLanguage properties.

The Connection variable can also be used to:

describe a new connection (equivalent to HDescribeConnection).
create a connection (that will be opened by HOpenConnection).
modify an existing connection.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

MaConnexion is Connection

// Description de la connexion
MaConnexion.User = "USER"
MaConnexion.MotDePasse = "PASSWORD"
MaConnexion.Server = "MONSERVEUR" 
MaConnexion.Database = "Base de données"
MaConnexion.Provider = hAccessHFClientServer
MaConnexion.Access = hOReadWrite
MaConnexion.ExtendedInfo = "BDD_EXISTE"
MaConnexion.Encryption = hEncryptionAES128
MaConnexion.CursorOptions = hClientCursor

// Ouverture de la connexion
HOpenConnection(MaConnexion)

// Affectation de la connexion à tous les fichiers de données
HChangeConnection("*", MaConnexion)

Properties

WLanguage properties that can be used with a connection described programmatically

The properties specific to the connections are presented in the table below:

Note: The Provider and Serveror Provider and Source must be initialized when describing a connection.

Property name	Effect

Access	Allows you to manage the type of access for a connection (HFSQL Client/Server, OLE DB, ...): Read, Read/Write
ActiveDirectory	Used to manage the connection via Active Directory.
Database	Allows you to manage the name of the database associated with a connection (HFSQL Client/Server, OLE DB, ...). In the case of a database divided into schemas, the name of the schema in the database will be specified by HChangeName.
Compression	Allows you to manage the compression of data transmitted by the connection.
Encryption	Allows you to manage the type of encryption for the communication between the Client computers and the HFSQL server.
ExtendedInfo	Allows you to manage the additional information of a connection.
Caption	Allows you to find out and modify the caption of a connection.
Password	Allows you to change the password associated with a user on a connection. New in version 2025 Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string". To learn more about secret strings and how to use the vault, see Secret string vault.
Name	Allows you to find out the name of the connection
CursorOptions	Allows you to manage the different types of cursors used by the connection.
Provider	Allows you to manage the type of data handled by the connection.
Server	Allows you to manage the name of the server used in the connection. This property is equivalent to the Source property. This property is mainly used for the HFSQL Client/Server connections or for the Native Accesses on the servers. You have the ability to specify an IPv6 address by writing the IPv6 address between square brackets. In this case, the port number must be specified after the closing square bracket. For example: [0154:2145:2155::5554]:4900.
Source	Allows you to manage the name of the data source used in the connection. This property is equivalent to the Server property. This property is mainly used for a connection on MS Access or on an xBase file.
CacheSize	Manage cache size
User	Allows you to manage the user of the connection

Remarks

Oracle Native Connector: external authentication management

To connect via an external authentication:

the User property must correspond to "/" (slash)
the Password property must correspond to "" (empty string)

Note: External authentication relies on the Windows user name and password to connect to the database. The external authentication requires configuring the server. See the Oracle documentation to learn more about how to authorize external authentications on the server.

Code equivalents: Description of a connection

Code that uses HDescribeConnection:

HDescribeConnection("MaConnexion", "USER", "PASSWORD", "SERVEURTEST", ...
	"Base de données", hAccessHFClientServer, hOReadWrite, ...
	"BDD_EXISTE", hClientCursor)

Code that uses the connection:

MaConnexion is Connection
// Description de la connexion
MaConnexion.User = "USER"
MaConnexion.MotDePasse = "PASSWORD"
MaConnexion.Server = "SERVEURTEST"
MaConnexion.Database = "Base de données"
MaConnexion.Provider = hAccessHFClientServer
MaConnexion.Access = hOReadWrite
MaConnexion.ExtendedInfo = "BDD_EXISTE"
MaConnexion.Encryption = hEncryptionAES128
MaConnexion.CursorOptions = hClientCursor

Code equivalents: Opening a connection

Code that uses HOpenConnection:

HOpenConnection("MaConnexion", "USER", "PASSWORD", "SERVEURTEST", ...
	"Base de données", hAccessHFClientServer, hOReadWrite, ...
	"Infos étendues", hClientCursor)

Code that uses the connection:

MaConnexion is Connection
// Description de la connexion
MaConnexion.User = "USER"
MaConnexion.MotDePasse = "PASSWORD"
MaConnexion.Server = "SERVEURTEST"
MaConnexion.Database = "Base de données"
MaConnexion.Provider = hAccessHFClientServer
MaConnexion.Access = hOReadWrite
MaConnexion.ExtendedInfo = "BDD_EXISTE"
MaConnexion.Encryption = hEncryptionAES128
MaConnexion.CursorOptions = hClientCursor
HOpenConnection(MaConnexion)

Code equivalence: Assign a connection

Code that uses HChangeConnection:

HChangeConnection(CLIENT, MaConnexion)

Code that uses the connection:

CLIENT.Connexion = MaConnexion

Code equivalence: Modifying an existing connection

Code that uses HDescribeConnection:

HDescribeConnection(MaConnexion, "USER2", "PASSWORD2", MaConnexion.CxBaseDeDonnées, ...
	MaConnexion.CxInitialCatalog, ...
	MaConnexion.CxProviderOLEDB, MaConnexion.CxAccès, ...
	MaConnexion.CxInfosEtendues, MaConnexion.CxOptionsCurseur)

Code that uses the connection:

// Modifie le login et le mot de passe pour la connexion
MaConnexion.Utilisateur = "USER2"
MaConnexion.MotDePasse = "PASSWORD2"