AX_SetExactKeyPos()

Advantage Visual Objects RDD

  Previous topic Next topic  

Returns and sets the Exact Key Position Flag.

Syntax

AX_SetExactKeyPos( [.T. | .F.] ) -> logical

 

[.T.|.F.] A logical value used to set the Exact Key Position TRUE (.T.) or FALSE (.F.).

Returns

If no parameter is passed to AX_SetExactKeyPos(), then it returns the current Exact Key Position setting. If a parameter is passed to AX_SetExactKeyPos(), then it returns previous Exact Key Position setting.

Description

The Exact Key Position setting is used internally by the Advantage RDD in calls to OrderKeyNo(). By setting Exact Key Position to false, Advantage will return an estimation of the key number. This provides a faster, but less accurate, method of obtaining the current key number. This is useful for applications that utilize the key number intensively (for example bBrowser). The default Exact Key Position setting is TRUE.

Example

oDB := AxDBServer{ "TEST", .F., .F., "AXDBFCDX" }

 

// With the default Exact Key Position setting, Advantage will compute the exact key number that can be expensive

lKeyNo := oDB:OrderKeyNo()

 

AX_SetExactKeyPos( .F. )

 

// With Exact Key Position set to false, Advantage will return an estimate of the key number which should be much faster

lKeyNo := oDB:OrderKeyNo()