PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

  • Read operation according to a key item or not
  • Memos
  • Lock
  • Miscellaneous
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Moves several records forward from the current position in the data file, according to a specified item.
The destination record is read and loaded in memory: HFSQL variables are updated (e.g. Customer.Name, i.e. item Name of data file Customer).
Several cases may occur after the call to HForward:
  • no other record exists in the data file: HOut returns True. No read operation is performed.
  • the function tries to lock a record that is already locked in read-only: HErrorLock returns True and HOut returns True.
    PHP Management of locks not available in PHP.
    Java Access by JDBC: The management of locks is not available for databases accessed by JDBC.
    Android Management of locks not available in SQLite databases.
This function can be used with the HFSQL files, views or queries.
// Moves to the 2000th record
// of the Customer file according to the CustName key
HReadFirst(Customer, CustomerName)
HForward(Customer, CustName, 1999)
WINDEVWEBDEV - Server codeReports and QueriesJavaUser code (UMC)HFSQLHFSQL Client/ServerHyper File 5.5OLE DBNative Connectors (Native Accesses)
// Check the status report of HForward
// Moves to the 2000th record
// of the Customer file according to the CustName key
HReadFirst(Customer, CustomerName)
IF HForward(Customer, CustName, 1999, hLockWrite) = False THEN
IF HErrorLock() = True THEN
Info("This record is currently used")
ELSE
Error(HErrorInfo())
END
END
Syntax
<Result> = HForward([<Data file>] [, <Item> [, <Step> [, <Options>]]])
<Result>: Boolean
  • True if the move was performed in the file,
  • False if an error occurred (lock, end of file, etc.): the record is not read. HError is used to identify the error.
<Data file>: Optional character string
Name of the data file, view or query used.
If this name is not specified, HForward will use the last data file used by the last HFSQL function (function starting with "H").
PHP This parameter corresponds to a file name.
<Item>: Optional character string
Name of item according to which the browse is performed.
If this name is not specified, HForward handles the last item in the data file used by the last HFSQL function (function starting with "H").
<Step>: Optional integer
Number of steps forward (which means number of records to browse). By default, <Step> = 1.
PHP <Step> is mandatory if <Item> was specified.
<Options>: Optional Integer constant (or combination of constants)
Configures:
  • the lock mode applied to the record read. By default, the lock performed corresponds to the current lock.
    hLockNoNo lock: the record can be read or modified by another application during the reading.
    hLockReadWriteLock in read/write: the record currently read cannot be read or modified by another application.
    hLockWriteLock in write mode: the record currently read can be read by another application but it cannot be modified by another application.

    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.
    Java Access by JDBC: The management of locks is not available for databases accessed by JDBC.
    AndroidAndroid Widget Management of locks not available in SQLite databases.
  • the management of duplicates during the browse. By default, all the duplicates are browsed.
    hDistinctWhen a browse is performed on a key item, a single record is browsed if duplicates are found.
Hyper File 5.5 <Options> is ignored.
PHP <Options> is ignored.
Remarks

Read operation according to a key item or not

In all cases, the browse operation must have been initialized by one of the following functions: HReadFirst, HFirst, HReadSeekFirst, HSeekFirst, HChangeKey, HRestorePosition.
If the item used is a key item:
  • if the hDistinct constant is not specified, HForward moves forward <Step> key values from the current position.
  • if the hDistinct constant is specified, HForward moves forward <Step> key values from the current position. If duplicates are found, a single duplicate is read.
If the item used is not a key item:
  • the hDistinct constant is not available.
  • HForward moves foward from <Step> active records from the current position.

Memos

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

Lock

By default (no lock variable specified), the lock performed corresponds to the current lock mode.
If a lock is specified (hLockWrite or hLockReadWrite constant), the record will be read and locked only if it is not already locked by another application.
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.
PHP Locks are not supported.

Miscellaneous

  • The result of HFound must be ignored (HFound must be used for the searches performed by HReadSeek).
  • The current record number is returned by HRecNum.
  • HForward respects the current active filter (defined by HFilter).
  • HChangeKey is used to modify the search key while remaining positioned on the current record.
  • HForward(Customer,Name) is equivalent to HReadNext(Customer,Name)
Component: wd270hf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment