HListFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

Displaying the result in a List Box or Combo Box control
HListFile function and the Native MySQL or MariaDB Connector

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HListFile (Function)

In french: HListeFichier

Not available with this kind of connection

Returns the list of data files:

found in the current analysis or in a specific analysis recognized by the HFSQL engine. The data files defined by HDeclare, HDeclareExternal and HDescribeFile are taken into account.
available on a connection via a native access or via an OLE DB driver.
for a group defined in the data model editor.
The groups defined in the data model editor are not supported.

Example

See additional examples

// Retrieve the data files described in the analysis and through programming
FileList is string
FileList = HListFile(hLstDétail + hLstAll)
// Add the list of data files in COMBO_COMBO1
ListAdd(COMBO_COMBO1, FileList)
// Display in a trace
Trace(FileList)

Syntax

Listing the data files of an analysis Hide the details

<Result> = HListFile([<Path of the WDD file> [, <Password of the WDD file>]] [, <Options>])

<Result>: Character string

List of data files found in the current analysis or in the specified analysis. The descriptions of each analysis are separated by a CR character (Carriage Return). The result is more or less detailed depending on the constant used:
hLstDetail is not specified <Name of data file 1> + CR + <Name of data file 2> + CR + ...
hLstDetail is specified <Name of data file 1> + TAB + <Abbreviation> + TAB + <Caption> + TAB + <Physical name> + CR + ...

Where:
<Name of data file X>: Logical name of the data file (used in programming).
<Abbreviation>: Abbreviation of data file.
<Caption>: Caption of data file.
<Physical name>: Physical name of data file (on disk).

<Path of the WDD file>: Optional character string

Full path of analysis (.WDD file) where the data file is described.
If this parameter is not specified or if it is equal to an empty string (""), the data file is sought in the current analysis.

<Password of the WDD file>: Optional character string

Password defined for the analysis.
If no password is defined, this parameter must be equal to an empty string ("").

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

Configures the type of list to perform:
hLstNormal
(default value) List not sorted, not detailed, without the data files described by programming.
hLstDetail Lists the detailed information (same as WINDEV 5.5).
hLstAll Lists all the data files (including the ones described by HDeclare, HDeclareExternal and HDescribeFile).
This parameter is ignored.
hLstSorted Sorts the list of data files in ascending order.
This parameter is ignored.

Listing the data files of a group Hide the details

<Result> = HListFile(<Group name> [, <Options>])

<Result>: Character string

List of data files belonging to the group. The descriptions of each data file are separated by a CR character (Carriage Return).

<Group name>: Character string

Name of the data file group. This group of data files was defined in the data model editor.

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

Configures the type of data files to list:
hLstStoredProcedure List of stored procedures.
hLstQuery Lists the queries that have been run.
hLstTable
(default value) List of user tables.
The names of tables correspond to the physical names of data files.
hLstSystemTable List of system tables.
This option is not available.
hLstView List of views.
Native Oracle Access: The hLstView constant is used to list the views and the synonyms.

Lists the SQL views.
hLstMaterializedView
List of materialized views.

Listing the data files of a connection via Native Connectors, OLE DB or HFSQL Client/Server (1) Hide the details

<Result> = HListFile(<NConnection> [, <Options>])

<Result>: Character string

List of data files accessible by the connection. The descriptions of each data file are separated by a CR character (Carriage Return).

<NConnection>: Character string

Name of connection to a database. This connection was defined in the data model editor or by HOpenConnection.

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

Configures the type of data files to list:
hLstStoredProcedure List of stored procedures.
hLstQuery Lists the queries that have been run.
hLstTable
(default value) List of user tables.
The names of tables correspond to the physical names of data files.
hLstSystemTable List of system tables.
This option is not available.
hLstView List of views.
Native Oracle Connector: The hLstView constant is used to list the views and the synonyms.

Lists the SQL views.
hLstMaterializedView
List of materialized views.

Listing the data files of a connection via Native Connectors or OLE DB (2) Hide the details

<Result> = HListFile(<Username> , <Password> , <Data source> , <OLE DB provider or Native Connector> [, <Access> [, <Options>]])

<Result>: Character string

List of data files accessible by the connection. The descriptions of each data file are separated by a CR character (Carriage Return).

<Username>: Character string

Name of the user of the data source.

<Password>: Character string

Password defined for the access to the data source (if it exists), empty string ("") if no password is defined.

<Data source>: Character string

Full path of data source used.

<OLE DB provider or Native Connector>: Character string or constant

Name of the OLE DB provider 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).
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).
hNativeAccessSQLAzure Native SQL Azure Connector (optional module of WINDEV/WEBDEV, supplied with Native SQL Server Connector).
hNativeAccessSQLite Native SQLite Connector.
hNativeAccessSQLServer Native SQL Server Connector (optional module of WINDEV/WEBDEV).
hNativeAccessSQLServerMobile Native SQL Server Connector (optional module of WINDEV Mobile).
hNativeAccessSybase Native Sybase Connector (optional module of WINDEV/WEBDEV).
hNativeAccessXBase Native xBase Connector (provided 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.
hOledbAccess2007 OLE DB provider for Access 2007.
hOledbAccess2010 OLE DB provider for Access 2010.
hOledbDBase5 OLE DB provider for dBase 5.
hOledbExcel2000 OLE DB provider for Excel 2000.
hOledbExcel2007 OLE DB provider for Excel 2007.
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.

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.
Only the following Native Connectors can be used:
hNativeAccessAS400 Native AS/400 Connector (optional module of WEBDEV).
hNativeAccessMariaDB Native MariaDB Connector (optional module of WINDEV/WEBDEV).
hNativeAccessMySQL Native MySQL Connector (optional module of WEBDEV).
hNativeAccessOracle Native Oracle Connector (optional module of WEBDEV).
hNativeAccessPostgreSQL Native PostgreSQL Connector (optional module of WEBDEV).

<Access>: Integer constant (optional)

Type of access to the database:
hOReadWrite
(default value) Opening in Read/Write.
hORead Opening in read-only.

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

Configures the type of data files to list:
hLstStoredProcedure List of stored procedures.
This option is not available.
hLstQuery Lists the queries that have been run.
hLstTable
(default value) List of user tables.
The names of tables correspond to the physical names of data files.
hLstSystemTable List of system tables.
This option is not available.
hLstView List of views.
Native Oracle Connector: The hLstView constant is used to list the views and the synonyms.

Lists the SQL views.
hLstMaterializedView
List of materialized views.

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. Each row will contain the full name of one of the analyses found.

HListFile function and the Native MySQL or MariaDB Connector

For the Native MySQL Connector, HListFile has evolved along with the versions:
- In version 15, HListFile returns the list of files in the current database.
- In version 16, to be able to use the new features of MySQL 5, if the Native Connector is connected to a MySQL 5 server (or later), HListFile returns the list of files from all accessible databases. In this case, the name of the file has the following format: "<Database name>.<File name>.
- Starting with version 170069, HListFile returns the list of files in the current database. HListDatabase lists the accessible databases and their files.
For the Native MariaDB Connector, HListFile returns the list of files from the current database. HListDatabase lists the accessible databases and their files.

Component: wd290hf.dll