_BtCreateIndex() Function

 

<< Click to Display Table of Contents >>

Navigation:  Low Level Functions >

 

_BtCreateIndex() Function

 

Previous pageReturn to chapter overviewNext page

 

Purpose

 

 

Create a new index for an open Btrieve file

 

 

 

Prototype

 

 

FUNCTION _BtCreateIndex ( hFile AS PTR, PTRKeySpec AS PTR,   nBufLen AS  WORD, nKey  := 0XFF AS BYTE )  AS LOGIC

 

 

 

Argument(s)

 

 

<hFile>                File handle that was returned by _BtOpen

<ptrKeySpec>        Pointer to KeySpec structure(s) that contains the segment informatoin

                 for the index that is to be created

<nBufLen>                Size of the KeySpec structure

<nKey>                (Optional) Key number to assign to the new index. By default the index will

                 get the next available key number. (0 is the first, 1 is the second etc.)

 

 

 

 

Return

 

 

LOGICwas the new index created succesfully

 

 

 

See Also

 

 

_BtCreate(), strKeySpec