ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • Read operation according to a key
  • Comparison between <Source>.Previous and .ReadPrevious
  • Miscellaneous
  • Locks
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
Positions on the previous file record according to a browse item. The record is not read.
The number of the current record is modified only when it is returned by <Source>.RecNum. For the functions that handle the current record number (<Source>.Delete, <Source>.Read, <Source>.Modify, etc.), the value of this number is not updated: you must use <Source>.RecNum(). For example: not to do:
Customer.Delete()
but
Customer.Delete(Customer.RecNum())
Values in the browse item are read in ascending order (see Remarks for more details).
Caution: The record loaded in memory is not modified. The HFSQL variables (Customer.Name for example, which means the Name item of Customer file) are not updated.
In most cases, <Source>.Previous sets the position in the data file to loop through the records that match a condition. <Source>.Next is used to position on the next record corresponding to the condition.
Several cases may occur after the call to <Source>.Previous:
  • a record corresponding to the condition was found: <Source>.Found returns True
  • the data file is empty or there is no record corresponding to the condition: <Source>.Out returns True
Remarks:

Values in the browse item are read in descending order (see remarks for more details).
Caution: The record loaded in memory is not modified. The HFSQL variables (Customer.Name for example, which means the Name item of Customer file) are not updated.
In most cases, <Source>.Previous is used to position in the data file during a browse loop.
Several cases may occur after the call to <Source>.Previous:
  • the data file is empty or no record corresponds to the filter (defined by <Source>.Filter): <Source>.Out returns True.
  • the function tries to lock a record that is already locked in read-only: HErrorLock returns True and <Source>.Out returns True.
    Java Access by JDBC: The management of locks is not available for databases accessed by JDBC.
Example
Customer.Last(Name)
WHILE Customer.Out() = False
// Process the record
Customer.Previous(Name)
END
Syntax
<Result> = <Source>.Previous([<Search key item> [, <Options>]])
<Result>: Boolean
  • True if the position was set,
  • False if an error occurred. This problem can be caused by:
<Source>: Type corresponding to the specified source
Name of the HFSQL data file used.
<Search key item>: Optional character string
Name of key item used to loop through the data file. If this name is not specified, <Source>.Previous will use the last browse item used on this file by the last HFSQL management function (function starting with "H"). If this item does not exist, the best browse item is automatically used.
<Options>: Optional constant
Configures the lock and the management of duplicates performed on the record selected by <Source>.Previous:
hDistinctIf duplicates are found, it is used to position on a single record among the duplicates. This parameter is taken into account only if the browse is performed on a key item.
By default, all the duplicates are browsed.
hLockNoNo lock: the record can be read or modified by another application.
hLockReadWriteLock in read/write: the selected record cannot be read or modified by another application.
hLockWriteLock in write mode: the selected record can be read by another application but it cannot be modified by another application.
Java Access by JDBC: This parameter is ignored.
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.
OLE DB The lock options specified by <Source>.Previous will be ignored. The lock mode specified by <Source>.First or <Source>.Last will remain effective during the calls to <Source>.Previous and <Source>.Next.
To modify the lock mode, you must use:
Native Connectors (Native Accesses) For Native Oracle Connector, a different lock mode can be specified for each record. However, if a transaction was started by SQLTransaction before setting the lock, the lock will only be released at the end of the transaction (SQLTransaction with the sqlCommit or sqlRollBack constant).
Hyper File 5.5 The lock options are ignored. Use the lock functions (<Source>.LockRecNum) kept for backward compatibility.
Remarks

Read operation according to a key

<Source>.Previous sets the position on the record with the greatest key value.
The sort order is the one that was specified in the analysis for this key.

Comparison between <Source>.Previous and <Source>.ReadPrevious

<Source>.Previous does not read the record: therefore, <Source>.Previous is faster than <Source>.ReadPrevious.
WINDEVWEBDEV - Server codeUniversal Windows 10 AppiPhone/iPadJavaUser code (UMC)External languageAjaxHFSQL ClassicHFSQL Client/ServerStored proceduresHyper File 5.5OLE DBNative Connectors (Native Accesses)

Miscellaneous

The current record number is returned by <Source>.RecNum.
<Source>.ChangeKey is used to modify the search key while remaining positioned on the current record.
WINDEVWEBDEV - Server codeReports and QueriesUniversal Windows 10 AppiPhone/iPadUser code (UMC)External languageAjaxHFSQL ClassicHFSQL Client/ServerStored proceduresOLE DBNative Connectors (Native Accesses)

Locks

By default (<Options> not specified), the record is not locked.
If a lock is requested (hLockWrite or hLockReadWrite constant), the position will be set on the record only if it is not already locked.
Component: wd290hf.dll
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 07/06/2023

Send a report | Local help