ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • Specific items
  • External language
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
HRetrieveItem (Function)
In french: HRécupèreRubrique
ODBCNot available with this kind of connection
Returns the content of an item found in the current record (in the data file, view, query, ...).
Example
NomClient is string
// La seconde rubrique du fichier de données "Client" 
// correspond au nom du client
NomClient = HRetrieveItem(Client, 2)
// Equivalent à :
// NomClient = Client.Nom
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 a heading can be obtained via its properties (<Fichier de données>.<Rubrique>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 a heading can be obtained via its properties (<Fichier de données>.<Rubrique>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.
Please note: for compatibility with Hyper File 5.5, separators are not shown when array fields 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).
WINDEVExternal languageHFSQL ClassicHFSQL Client/ServerHyper File 5.5OLE DBNative Connectors (Native Accesses)

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: wd300hf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/27/2025

Send a report | Local help