HGetCurrentPosition (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Position in relation to a key item or to a non-key item

Position in a filtered browse

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

Position in relation to a key item or to a non-key item
Position in a filtered browse

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HGetCurrentPosition (Function)

In french: HPositionCourante

Not available with this kind of connection

Returns the approximate position of current record in the data file. This position is given in relation to a specific item.

Remark: The position is given approximately for performance reasons. The position is calculated according to the position in the index.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

HSeek(CUSTOMER, NAME, "Smith")
IF HFound(CUSTOMER) = True THEN
Percentage is int = HGetCurrentPosition(CUSTOMER, NAME)/10
Info("The first SMITH is at " + Percentage + "% of CUSTOMER on the NAME key")
END

Syntax

<Result> = HGetCurrentPosition([<Data file> [, <Item>] [, <Precision>]])

<Result>: Integer

Approximate current position, plotted to the [1;1000] interval.
-1 if an error occurs (empty data file, filter returning no result, etc.). HErrorInfo returns more details about the problem.

<Data file>: Optional character string (with or without quotes)

Name of data file used. If this name is not specified, HGetCurrentPosition uses the last data file used by the last HFSQL management function (starting with "H").

<Item>: Optional character string (with or without quotes)

Name of item used. If this name is not specified, HGetCurrentPosition uses the last item used by the last HFSQL management function (starting with "H").

<Precision>: Optional integer

Defines the precision with which the position is evaluated. Caution: The higher the precision, the longer it takes to evaluate the position in the file.
hPrecisionLow Low precision.
hPrecisionMedium
(default value) Medium precision.
hPrecisionHigh High precision.

This parameter is ignored.
This parameter is ignored. The calculation is always performed with a high precision.

Remarks

Position in relation to a key item or to a non-key item

For a key item, the position returned is relative to the position of the record in the index of this item.

For a non-key item, the position is relative to the record number in the data file (see HRecNum).

Position in a filtered browse

If a filter with bounds is defined (HFilter without condition string but with lower and upper bounds), the returned position is relative to the records selected by the filter.

If a condition string is given to HFilter, the returned position ignores the filter.

Component : wd250hf.dll