Home | Sign in | English EN

  • Records read
  • Browsing a data file
  • Memos
  • Locks
  • Various
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Stored procedures
Reads a record in a data file according to a given record number. This read mode is called "Direct access". The record read is loaded in memory. HState is used to find out the record status (active, crossed or deleted).
In most cases, HRead is used to position in the data file in order to perform a read loop by specifying the record number.
Several cases may occur after the call to HRead:
  • the specified record number does not exist (greater than the total number of records or negative): no reading is performed and HOut returns True.
  • the specified record number does not exist anymore (crossed record, deleted record, ...): no read operation is performed and HOut returns False.
    Use HState to find out the record status.
  • the data file is empty: HOut returns True.
  • the function tries to lock a record that is already locked in read-only: HErrorLock returns True and HOut returns True.

This function can be used with the data files (indexed or not) and with the HFSQL views.
Remark: From version 19, HFSQL is the new name of HyperFileSQL.
// Sequential browse to display the name of all customers
i is int
FOR i = 1 _TO_ HNbRec(Customer, hStateAll)
HRead(Customer, i)
IF HState() = hStateActive THEN
Info("Customer name: " + Customer.Name)
<Result> = HRead([<Data file> [, <Record number> [, <Options>]]])
<Result>: Boolean
  • True if the record was read,
  • False if an error occurred (lock, end of data file, etc.): the record is not read. HError is used to identify the error.
<Data file>: Optional character string (with or without quotes)
Name of HFSQL data file, view or query used.
If this parameter corresponds to an empty string (""), HRead will use the last data file used by the last HFSQL management function (function starting with "H").
<Record number>: Optional integer
Number of the record to read.
If this parameter is not specified (or if it is equal to 0 or to the hCurrentRecNum constant), HRead handles the current record.
OLE DBNative Connectors (Native Accesses) HRead reads the current record. You cannot specify a record number other than the current one. To specify the current record number, use the hCurrentRecNum constant.
<Options>: Optional constant
Configures the lock set on the record read by HRead:
hLockNoNo lock (even if HStartLock was called): the record can be read or modified by another application during the reading.
hLockWriteLock in write mode: the record currently read can be read by another application but it cannot be modified by another application.
hLockReadWriteLock in read/write: the record currently read cannot be read or modified by another application.
Hyper File 5.5 The lock options are ignored. Use the lock functions (HLockRecNum) kept for backward compatibility.
OLE DBNative Connectors (Native Accesses) The lock options will have no effect if the locks are not supported by the OLE DB provider or by the Native Connector.
Reports and QueriesHFSQLHFSQL Client/ServerHyper File 5.5

Records read

HRead is the only function that can be used to access a crossed or deleted record. If the record is deleted, the content of the record is not valid anymore.

Browsing a data file

HRead cannot be used to continue a browse started by HReadFirst, HReadNext.


The memos associated with the record can be automatically read (or not) when reading the record. HSetMemo is used to customize this automatic read operation.
If the memos are supported, the associated text memos are read when the record is read. The binary memos are read only when they are explicitly used (HExtractMemo).
Reports and QueriesHFSQLHFSQL Client/ServerHyper File 5.5OLE DBNative Connectors (Native Accesses)


By default (<Options> not specified), the record is not locked.
If a lock is requested (hLockWrite or hLockReadWrite constant), the record will be read only if this record is not already locked.
There is no need to specify a lock parameter if the data file is locked by HStartLock: the lock specified by HStartLock is automatically taken into account. To ignore the lock specified by HStartLock, use the hLockNo constant.
OLE DBNative Connectors (Native Accesses) The lock options will have no effect if the locks are not supported by the OLE DB provider or by the Native Connector.


The result of HFound must be ignored (HFound must be used for the searches performed by HReadSeekFirst and HReadSeekLast).
The current record number is returned by HRecNum. The first record found in the data file is record #1.
Component : wd260hf.dll
Minimum version required
  • Version 9
This page is also available for…
Click [Add] to post a comment