BtIndex Class

<< Click to Display Table of Contents >>

Navigation:  Support Classes >

BtIndex Class

Previous pageReturn to chapter overviewNext page

 

Purpose

 

 

Strongly typed class that holds the index information

 

 

 

Prototype

 

 

CLASS BtIndex

 

 

 

Access

 

 

Flags                

 

 

 

 

Method

 

 

BuildExpression()This method will build a key expression based on the index segments and their fields

 

Init()Constructor of BtIndex Class                

 

SetKeyValues()This method will convert the VO Key values to btrieve Key values                

 

 

 

 

Description

 

 

This class is used by the BtTable class to store information about its indexes

 

 

 

Source Code

 

 

CLASS BtIndex

  EXPORT nOrder        AS WORD            // Order number

  EXPORT aSegments     AS ARRAY          // Array of index segments in this array

  EXPORT nFlags        AS WORD            // Index Flags

  EXPORT oTable        AS BtTable        // Work area object

  EXPORT nKeySize      AS DWORD          // Total Size of Key

  EXPORT cExpression   AS STRING          // String representation of Key expression

  EXPORT cName         AS STRING          // Index name (optional)

  EXPORT ptrKeyInfo    AS PTR            // Pointer to key information in Work Areas Stat

                                                 // Structure

  EXPORT aScopeTop     AS ARRAY          // Top Scope Values

  EXPORT aScopeBot     AS ARRAY          // Bottom Scope Values

  DECLARE METHOD SetKeyValues

 

 

 

 

 

 

See Also

 

 

BtSegment, BtTable