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
HRestorePosition. Then, the main process can continue.
HSavePosition 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 HRestorePosition to restore the stored filter.
// Find a record
HReadSeekFirst(Customer, Name, Name)
WHILE HFound(Customer) = True
// Saves the current context
nPos = HSavePosition(Customer, Name)
// Check a customer with another name
HReadSeek(Customer, Name, Name2)
IF HFound() = True THEN Counter = Counter + 1
// Restores the context
HRestorePosition(nPos)
HReadNext(Customer, Name)
END
Syntax
<Result> = HSavePosition([<Data file> [, <Item>]] [, <Options>])
<Result>: entier
- Number of the position that was saved,
- -1 if an error occurred.
<Data file>: Optional character string (with or without quotes)
Name of data file, view or query used. If this name is not specified, HSavePosition will use 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, HSavePosition saves the positions of all items for which a browse is in progress.
<Options>: Optional integer constant
Used to configure the backup:
| | |
| hSaveItems | Saves the values of items in memory when using HSavePosition. These values will be restored during the call to HRestorePosition. Versions 24 and later New in version 24 | |
Remarks
Example for managing the positions in a data file
HSavePosition and
HRestorePosition can be used in the following cases for example:
- form used to display a record and to browse the data file according to a key. Another window is called to display the data as a table. The management of the positions makes it possible to simply return to the correct Record in the course of the files.
- viewing a data file in a Table control. When selected, the record is displayed as a form, with the possibility of browsing through forms. The position management allows you to display the Table control again while being properly positioned on the data file.
Reinitializing positions
Caution: all the functions that open or close a data file reinitialize the context numbers (
HCreation,
HClose, etc.).
Various
- The number of calls to HSavePosition is not limited.
- You have the ability to nest HSavePosition and HRestorePosition for the same data file.
- If the record pointed during the call to HSavePosition is deleted, HRestorePosition cannot be called anymore.
Business / UI classification: Business Logic