PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Specific items
  • External language
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
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, ...).
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Versions 22 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for the Android applications.
WINDEVJava This function is now available for the Java applications.
New in version 22
iPhone/iPad This function is now available for the iPhone/iPad applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for the Android applications.
WINDEVJava This function is now available for the Java applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for the Android applications.
WINDEVJava This function is now available for the Java applications.
Example
CustomerName is string
// The second item of "CUSTOMER" 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(<File Name> , <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.
<File Name>: 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 is returned by its properties (<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(<File Name> , <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.
<File Name>: 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 is returned by its properties (<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).
WINDEVExternal languageHFSQLHFSQL Client/ServerHyper File 5.5OLE DBNative Connectors (Native Accesses)

External language

In external language, the <Result> is always retrieved in string format. The content of a binary memo item cannot be retrieved according to this method in external language.
Component : wd240hf.dll
See also
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment