HSavePosition (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

Example for managing the positions in a data file
Reinitializing positions
Miscellaneous
Repositioning by OLE DB and Native MySQL, DB2 and Informix Connectors

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HSavePosition (Function)

In french: HSauvePosition

Not available with this kind of connection

Stores the current context of a data file: current record, filter, read 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.

This function can be used with the data files, HFSQL views or queries.

Example

// Recherche d'un enregistrement
HReadSeekFirst(Client, Nom, Nom)
WHILE HFound(Client) = True
	// Sauve le contexte en cours
	nPos = HSavePosition(Client, Nom)
	// Vérification d'un client d'un autre nom
	HReadSeek(Client, Nom, Nom2)
	IF HFound() = True THEN Compteur = Compteur + 1
	// Restaure le contexte
	HRestorePosition(nPos)
	HReadNext(Client, Nom)
END

Syntax

<Result> = HSavePosition([<Data file> [, <Item>]] [, <Options>])

<Result>: Integer

Number of the position that was saved,
-1 if an error occurred.

<Data file>: Optional character string

Name of the data file, view or query used. If this name is not specified, HSavePosition will use the last data file used by the last HFSQL function (function starting with "H").

<Item>: Optional character string

Name of the item used. If this parameter is not specified, HSavePosition saves the positions of all items being looped through.
The <Rubrique> parameter will be ignored: the position will be saved for all browse items 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 next time HRestorePosition is called.
This constant is only available for HFSQL data files.

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 loop through the data file according to a key. Another window is called to display the data as a table. Positions allow you to easily go back to desired record in the iteration.
viewing a data file in a Table control. When selected, the record is displayed as a form, with the possibility of looping through forms. The position management allows you to display the Table control again while being properly positioned on the data file.

Reinitializing positions

Please note: all functions which open or close a data file reset the context numbers (e.g. HCreation, HClose, ...).

Miscellaneous

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.

Repositioning by OLE DB and Native MySQL, DB2 and Informix Connectors

If the database or the status of the iteration (e.g., reinitialized) does not allow resetting the position directly on the record, the position is set using the cache of records read.

The following functions reinitialize the iteration:

This operating mode is the same in Java.

Business / UI classification: Business Logic

Component: wd300hf.dll