HListKey (Function)

// Retrieve the keys of a file found in the current analysis
KeyList is string
KeyList = HListKey(CUSTOMER, hLstDetail)
// Adds the list of keys into COMBO_COMBO1
ListAdd(COMBO_COMBO1, KeyList)

Syntax

<Result> = HListKey(<File Name> [, <Path of WDD> [, <Password of WDD> [, <Options>]]])

<Result>: Character string

List of items found in the specified data file. The different descriptions of each key are separated by CR characters (Carriage Return). The listed keys are sorted according to the physical order of the keys in the data file (except if the hLstSorted constant is used).
The result is more or less detailed depending on the constant used:
hLstDetail is not specified <Name of Key 1> + CR + <Name of Key 2 + CR + ...
The result is identical with hLstKey and/or hLstCompositeKey and/or hLstSorted.
hLstDetail is specified <Name of Key 1> + TAB + <Type> + TAB+ <Size> + TAB + <Expression> + TAB + <Unique> + TAB + <Caption> + CR +...
hLstDetailPlus <Name of Key 1> + TAB + <Type> + TAB + <Size> + TAB + <Expression> + TAB + <Unique> + TAB + <Caption> + TAB + <Integer Part of Numeric Keys> + TAB + <Decimal Part of Numeric Keys> + CR +...
Where:
<Name of Key X>: name of the key
<Type>: type of key: "T" for text (and currency) or "N" for numeric
<Size>: item size
<Expression>: expression of the key for a composite key (for a simple key, only the key name is returned)
<Unique>: "1" for a unique key, "0" for a key with duplicates
<Caption>: caption of the key
<Integer Part of Numeric Keys>: number of digits in the integer part of numeric keys
<Decimal Part of Numeric Keys>: number of digits in the decimal part of numeric keys

<File Name>: Character string (with or without quotes)

Name of data file (query or view) whose keys will be listed.
If a query name is specified, this query must be currently run (HExecuteQuery or HExecuteSQLQuery) in order for HListKey to operate. Otherwise, a WLanguage error occurs.

<Path of WDD>: Optional character string (with quotes)

Full path of the analysis (which means .WDD file) in which 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 WDD>: Optional character string (with quotes)

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) Corresponds to hLstAll. Value used by default if the hLstKey, hLstCompositeKey and hLstAll constants are not used.
hLstKey Lists the key items (non-composite keys only).
This constant is ignored.
hLstCompositeKey Lists the composite key items only.
This constant is ignored.
hLstDetail Detailed information (idem WINDEV 5.5).
hLstDetailPlus For the numeric keys, add the number of digits found in the integer part and in the decimal part.
This constant is ignored.
hLstLogicalOrder Sorts the list in logical order of items (ignored if hLstSorted is specified).
This constant is ignored.
hLstOriginalItem Used on a log file (xxxJNL.fic), lists the keys of the initial source file (that was logged). For example, on CustomerJNL.Fic, list the key items of CUSTOMER file.
This constant is ignored.
hLstSorted Sorts the list in ascending order.
This constant is ignored.
hLstAll Lists all the keys (hLstKey + HLstCompositeKey).
This constant is ignored.

Remarks

Displaying the result in a list box or in a combo box

<Result> can be directly assigned to a list box or to a combo box by ListAdd. Each row will contain the name of one of the keys found.

Extracting an information from the result

To extract an information from the detailed result, we recommend that you use ExtractString.

Component : wd240hf.dll