• True if the operation was performed,
• False if a problem occurred. HErrorInfo is used to identify the error.

To establish this connection, use HOpenConnection (this function will return an error if the connection parameters are incorrect).

To assign this connection to a data file, use HChangeConnection.

Name of new connection to define.

If this name is already used by an existing connection, the former connection is replaced by the new one. The former connection (as well as the data files that used it) are automatically closed.

User name that will be used for the database. This parameter is returned by ..CtUserName.

Connection password (if this password exists). If no password is required, use an empty string ("") or the NULL keyword.

Full path of data source. The connection will be created and opened for this data source. This parameter is returned by ..CtDatabase.

XML: This parameter corresponds to the name of XML file.

This parameter corresponds to the server name. The port number used by the HFSQL server can be specified. The port 4900 will be used by default. If the port number of the HFSQL server is different, use the following notation:
<Computer name>: <Port number>
Example: "ComputerName:4901".
For a use via Internet, the ports must be managed by Firewall. See Managing ports for more details.

Versions 15 and later
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.

New in version 15
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.

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.

Access by JDBC:

• This parameter corresponds to URL for connecting to the database.
• Depending on the JDBC driver used, the database name must be specified in the connection URL.

For an Android application:

• Versions 18 and later
  Connection to an HFSQL Client/Server database:

  • The database is found on the development computer and it is handled from an Android emulator: use the IP address 10.0.2.2 with the server port. Example: "10.0.2.2:4900"
  • The database is found on the network of the development computer and it is handled from an Android emulator: use the full name of server with the domain. Example: "Server@domain.com:4900" (with the WINDEV Mobile simulator, the computer name without domain may be sufficient).
  New in version 18
  Connection to an HFSQL Client/Server database:

  • The database is found on the development computer and it is handled from an Android emulator: use the IP address 10.0.2.2 with the server port. Example: "10.0.2.2:4900"
  • The database is found on the network of the development computer and it is handled from an Android emulator: use the full name of server with the domain. Example: "Server@domain.com:4900" (with the WINDEV Mobile simulator, the computer name without domain may be sufficient).
  Connection to an HFSQL Client/Server database:
  • The database is found on the development computer and it is handled from an Android emulator: use the IP address 10.0.2.2 with the server port. Example: "10.0.2.2:4900"
  • The database is found on the network of the development computer and it is handled from an Android emulator: use the full name of server with the domain. Example: "Server@domain.com:4900" (with the WINDEV Mobile simulator, the computer name without domain may be sufficient).
• Connection to a SQLite database:
  Full path of the file containing the SQLite database on the Android device.
  Example : /sdcard/bdd/MyDatabase.db
  If the parameter corresponds to an empty string (""), the file containing the database data will be created in the "databases" directory of application and its name will be identical to the application name followed by the ".db" extension.

Name of database that will be used on the data source, empty string ("") if no name must be specified. This parameter can be used if the data source allows you to specify the database that must be used.
For example, on SQL Server, the "Master" database is the default database but other databases can be handled ("dbo" for example).
To specify that the access is performed on a file found in the "dbo" database (that is not the default database), <Database> must correspond to "dbo".

This parameter is returned by ..CtInitialCatalog.

• Name of OLE DB provider used. To easily retrieve the string to use, select "Connection" in the data model editor (see the Notes).
  
  or

• one of the following constants:
  

  hAccessHF7	Pseudo-connection to HFSQL Classic database
  hAccessHFClientServer	Native Connector to an HFSQL Client/Server database.
  hNativeAccessAS400	Native AS/400 Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessDB2	Native DB2 Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessInformix	Native Informix Connector (optional module of WINDEV/WEBDEV)
  Versions 20 and later hNativeAccessMariaDB New in version 20 hNativeAccessMariaDB hNativeAccessMariaDB	Native MariaDB Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessMySQL	Native MySQL Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessOracle	Native Oracle Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessOracleLite	Native Oracle Connector (optional module of WINDEV Mobile)
  hNativeAccessPostgreSQL	Native PostgreSQL Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessProgress	Native Progress Connector (optional module of WINDEV/WEBDEV)
  Versions 16 and later hNativeAccessSQLAzure New in version 16 hNativeAccessSQLAzure hNativeAccessSQLAzure	Native SQL Azure Connector (optional module of WINDEV/WEBDEV, supplied with Native SQL Server Connector)
  Versions 16 and later hNativeAccessSQLite New in version 16 hNativeAccessSQLite hNativeAccessSQLite	Native SQLite Connector (supplied with WINDEV/WEBDEV)
  hNativeAccessSQLServer	Native SQL Server Connector (optional module of WINDEV/WEBDEV). The former Native Connector is used by default. To force the use of new Native SQL Server Access, use the H.SQLServerMode variable.
  hNativeAccessSQLServerMobile	Native SQL Server Mobile Connector (optional module of WINDEV Mobile)
  hNativeAccessSybase	Native Sybase Connector (optional module of WINDEV/WEBDEV)
  hNativeAccessXBase	Native xBase Connector (supplied with WINDEV/WEBDEV)
  hNativeAccessXML	Native XML Connector (supplied with WINDEV/WEBDEV)
  hODBC	OLE DB provider for ODBC (used to access an ODBC data source declared in the ODBC data sources of Windows)
  hOledbAccess97	OLE DB provider for Access 97
  hOledbAccess2000	OLE DB provider for Access 2000
  hOledbDBase5	OLE DB provider for dBase 5
  hOledbExcel2000	OLE DB provider for Excel 2000
  hOledbExcel97	OLE DB provider for Excel 97
  hOledbLotus4	OLE DB provider for Lotus 4
  hOledbOracle	OLE DB provider for Oracle
  hOledbSQLServer	OLE DB provider for SQL Server

The available constants are as follows:

hAccessHF7	Pseudo-connection to HFSQL Mobile database
hAccessHFClientServer	Connection to HFSQL Client/Server database
hNativeAccessOracleLite	Native Oracle Lite Connector (optional module)
hNativeAccessSQLServerMobile	Native SQL Server Mobile Connector (optional module)

The available constants are as follows:

Versions 15 and later hNativeAccessSQLite New in version 15 hNativeAccessSQLite hNativeAccessSQLite	Native SQLite Connector from an Android application.

Caution: To use an OLE DB connection, you must:

• install MDAC version 2.6 or later (setup performed by WINDEV/WEBDEV and when creating the client version)
• install the OLE DB provider corresponding to the database used.
  This parameter is returned by ..CtOLEDBProvider.

The available constants are as follows:

hAccessHF7	Pseudo-connection to HFSQL Mobile database
hAccessHFClientServer	Connection to HFSQL Client/Server database
hAccessJDBCMySQL	Access to MySQL database via JDBC
Versions 15 and later hAccessJDBCSQLite New in version 15 hAccessJDBCSQLite hAccessJDBCSQLite	Access to SQLite database via JDBC
hAccessJDBCSQLServer	Access to SQL Server database via JDBC

This parameter can correspond to one of the following constants:

hNativeAccessAS400	Native AS/400 Connector (optional module of WEBDEV)
Versions 20 and later hNativeAccessMariaDB New in version 20 hNativeAccessMariaDB hNativeAccessMariaDB	Native MariaDB Connector (optional module of WINDEV/WEBDEV)
hNativeAccessMySQL	Native MySQL Connector (optional module of WEBDEV)
Versions 15 and later hNativeAccessOracle New in version 15 hNativeAccessOracle hNativeAccessOracle	Native Oracle Connector (optional module of WEBDEV)
Versions 15 and later hNativeAccessPostgreSQL New in version 15 hNativeAccessPostgreSQL hNativeAccessPostgreSQL	Native PostgreSQL Connector (optional module of WEBDEV)

Configures the type of access to the database.

hOReadWrite (default value)	The database can be accessed in read/write. You have the ability to read the records and to write new records.
hORead	The database can be accessed in read-only. You only have the ability to read the records. No record can be added or deleted.

This parameter is returned by ..CtAccess.

This parameter is not available.

Access by JDBC: This parameter is ignored.

Optional information inserted into the string for connecting to the database. If specific keywords are recognized, the corresponding information is extracted from the connection string. The rest of the connection string is sent to the database. Then, the extracted parameters are processed by the Native Connector or by the OLE DB connector used.
These keywords must be indicated as follows: "<Keyword> = <Value>;".

You can for example specify "Trusted_Connection=YES" in order to use a connection with authentication via the NT login.

The keywords recognized by OLE DB and the Native Connectors are presented in the Optional connection information page.

Example of string to use:

"WD Cache Size = 10000; Server Port=3306;"

Keywords recognized for the access by HFSQL Client/Server:

COMPRESSION	Enables or disables the compression of the data sent between the Client and the Server. This keyword can correspond to: TRUE to enable the data compression. FALSE to disable the data compression.
ENCRYPTION	Enables the encryption of the data exchanged between the Client and the Server. This keyword can take two values: FAST RC5_16 for a RC5 encryption (16 rounds).
DB_EXIST	Checks the existence of the database. If the specified database does not exist, HDescribeConnection returns False.

This parameter is returned by ..CtExtendedInfo.

This parameter is ignored.

HFSQL database accessed via a RMI server: This parameter corresponds to the address of RMI server and to the port used. The following format must be used: "RMI=<Server address>:<Port number>". For example: "RMI=192.168.52.148:1099".

Access by JDBC: This parameter is mandatory. It must correspond to the full name of JDBC driver to use. This name is case sensitive.

If this parameter is not specified, the HFSQL engine automatically defines the best parameters to use according to the database accessed and to the OLE DB provider used.

To force some parameters, you have the ability to combine the following constants:

• Location of cursors
  

  hClientCursor	Cursor managed by MDAC. Offers more features than a server cursor. A client cursor must necessarily be a static cursor.
  hServerCursor	Cursor managed by the database. This cursor can easily apply the changes performed by the other users to the data.

• Type of cursor
  

  hDynamicCursor	Cursor offering a lot of features but consuming a lot of memory. This cursor allows all types of moves. It allows you to access all the modifications, additions and deletions performed by the other users.
  hForwardOnlyCursor	Fast cursor consuming little memory. The move is performed from the first record to the last one. The data modified by the other users is not visible.
  hOpenKeysetCursor	Cursor that handles a fixed set of records. Only the keys corresponding to the record are stored and not the records (consumes less memory). The deleted records can no longer be accessed. The modifications performed by the other users are visible (but not the additions).
  hStaticCursor	Retrieves a copy of all the query records in memory (consumes a lot of memory). All types of moves are allowed.

• Lock mode
  

  hReadOnlyCursor	The set of records cannot be modified.
  hOptimisticCursor	The record is locked when it is updated
  hPessimisticCursor	The record is locked as soon as it becomes in edit to be modified.

Caution: some types of cursors may not be supported by all the OLE DB providers.

This parameter is returned by ..CtCursorOptions.

This parameter is ignored.