Stores the current context of a data file: current record, filter, pointers. This allows you to temporarily suspend the current process in order for the data file to be used somewhere else (to perform checks for example). The saved context can be restored by <Source>.RetourPosition
. Then, the main process can continue.
<Source>.SavePosition is used to save:
- the number of the record used,
- the different pointers in the index (the position in the index is saved for each key),
- the current filter. You will have to use the hRPFilter constant in <Source>.RetourPosition to restore the stored filter.
// Find a record
WHILE Customer.Found() = True
// Saves the current context
nPos = Customer.SavePosition(Name)
// Check a customer with another name
IF Customer.Found() = True THEN Counter = Counter + 1
// Restores the context
<Result> = <Source>.SavePosition([<Item>] [, <Options>])
- Number of the position that was saved,
- -1 if an error occurred.
<Source>: Type corresponding to the specified source
Name of data file, view or query used. If this name is not specified, <Source>.SavePosition handles the last data file used by the last HFSQL management function (function starting with "H").
<Item>: Optional character string (with or without quotes)
Name of item used. If this parameter is not specified, <Source>.SavePosition saves the positions of all items for which a browse is in progress.
The <Item> parameter will be ignored: the position will be stored for all items on which a browse is in progress.
<Options>: Optional integer constant
Used to configure the backup:
Example for managing the positions in a data file
- browsing a data file according to a key (form by form), calling another window in order to view in a table. The management of positions allows you to easily go back to the proper record in the form-by-form browse.
- viewing a data file in a Table control, selecting a record for a form-by-form access. The position management allows you to display the Table control again while being properly positioned on the data file.
- The number of calls to <Source>.SavePosition is not limited.
- You have the ability to nest <Source>.SavePosition and <Source>.RetourPosition for the same data file.
- If the record pointed during the call to <Source>.SavePosition is deleted, <Source>.RetourPosition cannot be called anymore.
Repositioning by OLE DB and Native MySQL, DB2 and Informix Connectors
If the database or the status of browse (re-initialized browse for example) does not allow you to directly reposition on the record, the positioning is performed in the cache of records read.
The following functions reinitialize the browse:
This operating mode is the same in Java.
Business / UI classification : Business Logic