HListConnection (Function)

Returns the list of connections currently described in the application. You have the ability list the connections described in the data model editor as well as the connections described by programming (with HDescribeConnection or HOpenConnection).

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

New in version 18

This function is now available in Windows Store apps mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Note: From version 19, HFSQL is the new name of HyperFileSQL.

Example

// Retrieve the list of connections
CntList is string = HListConnection(hLstDetail + hLstAll + hLstSorted)

// Insert the list into COMBO_Connection
ListAdd(COMBO_Connection, CntList)

Syntax

<Result> = HListConnection([<Options> [, <Separator of connections> [, <Separator of information>]]])

<Result>: Character string

List of defined connections. The different connections are separated by the <Separator of connections> (CR - Carriage Return - by default).
hLstDetail is not specified <Name of connection 1> + <Separator of connections> + <Name of connection 2> + <Separator of connections> +...
hLstDetail is specified <Name of connection 1> + <Separator of information> + <User> + <Separator of information> + <Data source> + <Separator of information> + <Provider name> + <Separator of information> + <Optional information> + <Separator of connections> +...

<Options>: Optional Integer constant (or combination of constants)

Configures the type of list to perform:
hLstNormal
(default value) List of connections, not sorted, without the connections described by programming.
hLstDetail Detailed information.
hLstOpened Lists the opened connections only.
hLstAll Lists all the connections (connections of analysis and connections defined dynamically by HDescribeConnection or HOpenConnection).
hLstSorted Sorts the list in ascending order.

<Separator of connections>: Optional character string

Versions 15 and later
Separator used to separate the different connections. This separator corresponds to a Carriage Return (CR) by default.
New in version 15
Separator used to separate the different connections. This separator corresponds to a Carriage Return (CR) by default.
Separator used to separate the different connections. This separator corresponds to a Carriage Return (CR) by default.

<Separator of information>: Optional character string

Versions 15 and later
Separator used to separate the information returned about the connections. This separator corresponds to a tabulation - TAB - by default.
New in version 15
Separator used to separate the information returned about the connections. This separator corresponds to a tabulation - TAB - by default.
Separator used to separate the information returned about the connections. This separator corresponds to a tabulation - TAB - by default.

Remarks

Displaying the result in a List Box or Combo Box control

<Result> can be directly assigned to a List Box or Combo Box control by ListAdd. If the <Separator of connections> corresponds to CR, each row will contain the full name of one of the connections found.

Component : wd240hf.dll