HListREP (Function)

Returns the list of assignments for the data files handled by the current application, which means the list of physical files corresponding to the data files described in the analysis.

For more details on this list, see List of data files handled by an application. Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Example

sAssignments is string
// Retrieve all the assignments of logical file
// CUSTOMER whose physical name is CUSTOMER2000 and that
// exist on disk
sAssignments = HListREP(".", "CUSTOMER", "CUSTOMER2000", hExisting)

// List all the entries in the .REP file of the project
// Equivalent syntax: HListREP()
sList is string
sList = HListREP(".","*")

Syntax

Listing the assignments from the .REP file Hide the details

<Result> = HListREP([<Name of REP file> [, <Logical file name> [, <Physical file name>]]] [, <Options>])

<Result>: Character string

List of assignments,
Empty string ("") if an error occurred.
The list of assignments has the following format:

<Logical name> + <TAB> + <Physical name> + TAB + <Directory> + CR +...

Where:
<Logical name>: Name of the data file in the analysis.
<Physical name>: Physical file name, without path and without extension.
<Directory>: Directory of physical file.
<Result> is filled with 2 new details:
<Server name>: Name of the HFSQL Client/Server server.
<Database name>: Name of the HFSQL Client/Server database.

<Name of REP file>: Optional character string

Full name of the analyzed .REP file. If this parameter corresponds to an empty string or to ".", the current ".REP" file is examined. The current ".REP" file is also examined if the first three optional parameters are not specified.
This parameter cannot be specified on its own. The following syntax is not available: HListREP(<Name of .REP file>).

<Logical file name>: Optional character string

Logical name of the data file whose assignments must be listed. If this parameter is not specified or if it is equal to "*", all the assignments of all the data files will be sought.

<Physical file name>: Optional character string

Physical name of the data file whose assignments must be listed. If this parameter is not specified, all the assignments of <Logical file name> are searched.

<Options>: Optional integer constant

All the assignments are sought by default. The hExisting constant is used to find the assignments for which a data file actually exists.

Listing the assignments from the .WDD file Hide the details

<Result> = HListREP([<Name of WDD File> [, <Logical file name> [, <Physical file name>]]] [, <Options>])

<Result>: Character string

List of assignments,
Empty string ("") if an error occurred.
The list of assignments has the following format:

<Logical name> + <TAB> + <Physical name> + TAB + <Directory> + CR +...

where:
<Logical name>: Name of the data file in the analysis.
<Physical name>: Physical file name, without path and without extension.
<Directory>: Directory of physical file.

<Name of WDD File>: Optional character string

Full name of the examined .WDD file. The current "WDD" file is examined if this parameter is not specified or if it corresponds to ".".

<Logical file name>: Optional character string

Logical name of the data file whose assignments must be listed. If this parameter is not specified or if it is equal to "*", all the assignments of all the data files will be sought.

<Physical file name>: Optional character string

Physical name of the data file whose assignments must be listed. If this parameter is not specified, all the assignments of <Logical file name> are searched.

<Options>: Optional integer constant

All the assignments are sought by default. The hExisting constant is used to find the assignments for which a data file actually exists.

Remarks

Compatibility with the earlier versions

The following syntax is not available anymore: HListREP(<WDD name>, "?").

Business / UI classification: Business Logic

Component: wd270hf.dll