Connection (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

WLanguage properties that can be used with a connection described programmatically
Native Oracle Connector: managing the external authentication
Equivalence between code: Describing a connection
Equivalence between code: Establishing a connection
Equivalence between codes: Assigning a connection
Equivalence between codes: Modifying an existing connection

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Connection (Variable type)

In french: Connexion

The Connection type is used to 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.

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

Example

MyConnection is Connection

// Describe the connection
MyConnection.User = "USER"
MyConnection.Password = "PASSWORD"
MyConnection.Server = "MYSERVER" 
MyConnection.Database = "Database"
MyConnection.Provider = hAccessHFClientServer
MyConnection.Access = hOReadWrite
MyConnection.ExtendedInfo = "Extended information"
MyConnection.CursorOptions = hClientCursor

// Open the connection
HOpenConnection(MyConnection)

// Assign the connection to all data files
HChangeConnection("*", MyConnection)

Remarks

WLanguage properties that can be used with a connection described programmatically

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

Remark: The Provider and Server properties, or Provider and Source properties must be initialized in the description of 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 modify the password associated with the user of a connection.
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	Allows you to manage the size of the cache
User	Allows you to manage the user of the connection

Native Oracle Connector: managing the external authentication

To connect via an external authentication:

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

Remark: The external authentication consists in using the name of Windows user and his 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.

Equivalence between code: Describing a connection

Code that uses HDescribeConnection:

HDescribeConnection("MyConnection", "USER", "PASSWORD", "TESTSERVER", ...
	"Database", hAccessHFClientServer, hOReadWrite, ...
	"Extended info", hClientCursor)

Code that uses the connection:

MyConnection is Connection
// Describe the connection
MyConnection.User = "USER"
MyConnection.Password = "PASSWORD"
MyConnection.Server = "TESTSERVER"
MyConnection.Database = "Database"
MyConnection.Provider = hAccessHFClientServer
MyConnection.Access = hOReadWrite
MyConnection.ExtendedInfo = "Extended information"
MyConnection.CursorOptions = hClientCursor

Equivalence between code: Establishing a connection

Code that uses HOpenConnection:

HOpenConnection("MyConnection", "USER", "PASSWORD", "TESTSERVER", ...
	"Database", hAccessHFClientServer, hOReadWrite, ...
	"Extended info", hClientCursor)

Code that uses the connection:

MyConnection is Connection
// Describe the connection
MyConnection.User = "USER"
MyConnection.Password = "PASSWORD"
MyConnection.Server = "TESTSERVER"
MyConnection.Database = "Database"
MyConnection.Provider = hAccessHFClientServer
MyConnection.Access = hOReadWrite
MyConnection.ExtendedInfo = "Extended information"
MyConnection.CursorOptions = hClientCursor
HOpenConnection(MyConnection)

Equivalence between codes: Assigning a connection

Code that uses HChangeConnection:

HChangeConnection(CUSTOMER, MyConnection)

Code that uses the connection:

CUSTOMER.Connection = MyConnection

Equivalence between codes: Modifying an existing connection

Code that uses HDescribeConnection:

HDescribeConnection(MyConnection, "USER2", "PASSWORD2", MyConnexion.CtDatabase, ...
	MyConnection.CtInitialCatalog, ...
	MyConnection.CtOLEDBProvider, MyConnection.CtAccess, ...
	MyConnection.CtExtendedInfo, MyConnection.CCursorOptions)

Code that uses the connection:

// Modifies the login and password for the connection
MyConnection.User = "USER2"
MyConnection.Password = "PASSWORD2"