- Specific items
- External language
HRetrieveItem (Function) In french: HRécupèreRubrique
 Not available with this kind of connection
Returns the content of an item found in the current record (in the data file, view, query, ...).
CustomerName is string
// The second item of the "Customer" data file
// corresponds to the name of the customer
CustomerName = HRetrieveItem(Customer, 2)
// Equivalent to:
// CustomerName = Customer.Name
Syntax
Retrieving an item by specifying its index Hide the details
<Result> = HRetrieveItem(<Data file> , <Item order> [, <Index>])
<Result>: Type of item - Value of the item,
- Empty string ("") for items with a NULL value.
For an array, all the array items are returned as character strings. The items are separated by the <Array separator> parameter.
<Data file>: Character string Name of data file, view or query used. <Item order>: Integer Physical order of the item in the data file. The order of the items starts from 1.
Reminder: The order of an item can be obtained using its properties (<Data file>.<Item>Index). <Index>: Optional integer Index of the item for an array item.
For the non-array items, the index is optional. If it is specified, it must be set to 1.
For array items, if the index is not specified, all the array elements are returned (separated by TAB characters).
Retrieving an item by specifying the array separator Hide the details
<Result> = HRetrieveItem(<Data file> , <Item order> [, <Array separator>])
<Result>: Type of item - Value of the item,
- Empty string ("") for items with a NULL value.
For an array, all the array items are returned as character strings. The items are separated by the <Array separator> parameter.
<Data file>: Character string Name of data file, view or query used. <Item order>: Integer Physical order of the item in the data file. The order of the items starts from 1.
Reminder: The order of an item can be obtained using its properties (<Data file>.<Item>Index). <Array separator>: Optional character string Character string used to separate the values of array items (or sub-items) in <Result>. The default separator is TAB.
Caution: for backward compatibility with Hyper File 5.5, the separators are not indicated when the array items are empty. Remarks Specific items - The content of Binary Memo items is not retrieved but the item separator is present (to avoid a shift).
- The content of composite keys is not retrieved but the item separator is present (to avoid a shift).
This page is also available for…
|
|
|
|