_BtGetNext() Function

 

<< Click to Display Table of Contents >>

Navigation:  Low Level Functions >

 

_BtGetNext() Function

 

Previous pageReturn to chapter overviewNext page

 

Purpose

 

 

Position the Btrieve file on the next logical record for a given index

 

 

 

Prototype

 

 

FUNCTION _BtGetNext ( hFile AS PTR, ptrData AS PTR, nRecLen REF WORD,   ptrKey AS PTR, nKeyNo AS BYTE )  AS LOGIC PASCAL

 

 

 

Argument(s)

 

 

<hFile>File handle that was returned by _BtOpen
<ptrData>Pointer to the data structure.
<nRecLen>Length of the data structure. This value must be at least as long as the fixed-length portion of the record.
<ptrKey>Pointer to the Key buffer. Allocate BSIMAX_KEY_SIZE for this buffer
<nKeyNo>Key Number, first key is numbered 0.

 

Returns

LOGICWas the move to the next logical record succesfull.

 

 

 

 

Description

 

 

If the Get Next operation is unsuccessful, the MicroKernel may return one of the following status codes:

 

03 File Not Open
04 Invalid Key Number
07 Different Key Number
08 Invalid Positioning
09 End of File
22 Data Buffer Length
82 Lost Position

 

 

 

 

See Also

 

 

_BtGetLast(), _BtGetFirst(), _BtGetPrevious()