Index Methods
Description
Alpha Anywhere provides the following Index methods.
Discussion
Use <TBL>.INDEX_PRIMARY_GET() to return the <Index> object pointer that references the primary index or query list of the table referenced by <TBL>. Prefix the following methods with the name of the <Index> object pointer.
Methods
- INDEX.CLOSE Method
The .CLOSE() method closes an index file or query list.
- INDEX.DROP Method
Drop the index from its table.
- INDEX.FETCH_STATE_LIST_GET Method
Returns list of fetch states from head or tail of an ASX file (direction depends on +/- records).
- INDEX.FILENAME_GET Method
Gets the index filename.
- INDEX.FILTER_GET Method
Gets the index filter expression.
- INDEX.FIND Method
Find a key in the index - returns the key found.
- INDEX.FIND_FIRST Method
Returns the first key value.
- INDEX.FIND_LAST Method
The .FIND_LAST() method returns the last key value.
- INDEX.FIND_NEXT Method
Find the key After the specified key - returns the key found.
- INDEX.FIND_PREVIOUS Method
Find the key Before the specified key, true TRUE if exact match, else returns key found.
- INDEX.FLAGS_GET Method
Gets the index flags.
- INDEX.IS_VALID Method
Is the current index valid.
- INDEX.KEY_GET Method
Returns the current key value.
- INDEX.KEY_LIST_GET Method
Returns cr-lf separated list of keys from head or tail of index/query (direction depends on +/- records).
- INDEX.KEY_POSITION_GET Method
Returns position of the record within the index.
- INDEX.KEY_RECORD_GET Method
Returns record at position within the index.
- INDEX.NAME_GET Method
Gets the index tag name.
- INDEX.ORDER_GET Method
Gets the index order expression.
- INDEX.PERSIST Method
If the index is a query, then set flag to indicate if it should stay around.
- INDEX.RECNO_LIST_GET Method
Returns list of record numbers from head or tail of index/query (direction depends on +/- records).
- INDEX.RECORDS_GET Method
Gets the number of records in an index.
- INDEX.TABLE_GET Method
Returns the table that the index is on.
- INDEX.TYPE_GET Method
Gets the type of index.
- INDEX.UPDATE Method
The .UPDATE() method updates all of the index tags in an index file.