HRetrieveItem (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

Specific items
External language

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

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, ...).

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

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

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.

Versions 22 and later

This function is now available for Java applications.

New in version 22

This function is now available for Java applications.

Example

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 subscript Hide the details

<Result> = HRetrieveItem(<Data file> , <Item order> [, <Subscript>])

<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 (with or without quotes)

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>..Subscript).

<Subscript>: Optional integer

Subscript of the item for an array item.
For the non-array items, the subscript is optional. If it is specified, it must be set to 1.
For array items, if the subscript 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 (with or without quotes)

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>..Subscript).

<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).

External language

In external language, the <Result> always corresponds to a character string. The content of a binary memo item cannot be retrieved according to this method in external language.

Component : wd250hf.dll