Group Index / Order Operations

Closes all index files in a work area.

DbClearIndex() --> NIL

Creates an index file in a work area.

DbCreateIndex( <cIndexFile>, <cIndexKey>, [<bIndexKey>], [<lUnique>] ) --> NIL

Checks if the order for navigation is descending

DbDescend() --> lNavIsDescend

Rebuilds open index files in a work area.

DbReindex() --> NIL

Determines the index tag of a child work area.

DbROrdName( <nRelation> | <cRelName> ) --> cTagName

Positions the record pointer to a record based on the value of an index expression

DbSeek( <IndexKeyValue>, [<lSoftSeek>], [<nIndex>|<cTagName>], [<lLast>] ) --> lFound

Reverses the navigational order of a work area.

DbSetDescend( <lDescend> ) --> NIL

Opens an index file in a work area.

DbSetIndex( <cIndexFile> ) --> NIL

Sets the controlling index in a work area.

DbSetOrder( <nIndex> ) --> NIL

Removes an index from a compound index file

DELETE TAG <cTagName> [OF <cIndexFile>] [, <cTagName> [OF <cIndexFile>]] DELETE TAG <cTagName> [IN <cIndexFile>] [, <cTagName> [IN <cIndexFile>]]

Gives an inverted index key value for sorting in descending order.

Descend( <Expression> [,<lCompatible>] ) --> DescendValue

Creates an index file.

INDEX ON <IndexKey> [TAG <cTagName>] TO <cIndexFile> [FOR <lForCondition>] [WHILE <lWhileCondition>] [NEXT <nCount>] [RECORD <xRecordID>] [EVAL <bBlock> [EVERY <nStep>] ] [REST] [ALL] [UNIQUE] [ASCENDING | DESCENDING] [ADDITIVE] [CANDIDATE] [SUBINDEX] [CUSTOM] Or for index files with multiple indexes: INDEX ON <IndexKey> TAG <cTagName> [TO <cIndexFile>] [FOR <lForCondition>] [WHILE <lWhileCondition>] [NEXT <nCount>] [RECORD <xRecordID>] [EVAL <lExpression> [EVERY <nStep>] ] [REST] [ALL] [UNIQUE] [ASCENDING | DESCENDING] [ADDITIVE] [CANDIDATE] [SUBINDEX] [CUSTOM]

Returns the default extension for index file names.

IndexExt() --> cExtension

Returns the index expression of an index file.

IndexKey( <nIndex> ) --> cIndexKey

Returns the ordinal position of the controlling index in a work area.

IndexOrd() --> nOrder

Returns the default extension for index file names.

OrdBagExt() --> cExtension

Returns the filename of the file containing an index.

OrdBagName( <nIndex> | <cTagName>, [<nInfo>] ) --> cIndexFile

Sets the conditions used to create indexes with OrdCreate().

OrdCondSet( [<cForCondition>], [<bForCondition>], [<lAllRecords>], [<bWhileCondition>], [<bOption>], [<nStep>], [<xnRecNo>], [<nNext>], [<xnRecord>], [<lRest>], [<lDescend>], [<lCandidate>], [<lSubIndex>], [<lCustom>] ) --> NIL

Determines the number of open indexes in a work area.

OrdCount() --> nOrdCount

Creates an index in an index file.

OrdCreate( <cIndexFile>, [<cTagName>], <cIndexKey>, [<bIndexKey>], [<lUnique>], [<lAdditive>] ) --> NIL

Deletes one or more indexes

OrdDestroy( [<cTagName>|<nIndex>] ) --> NIL

Returns the FOR condition of an index.

OrdFor( [<cTagName>|<nIndex>] ) --> cForExpression

Sets or returns information about an order/index

OrdInfo( <nDefine>, [<xNewSetting>] ) --> xOldSetting

Checks if an order is an candidate order

OrdIsCandidate([<cTagName>|<nIndex>]) -> lCandidate

Checks if a order is a Custom order.

OrdIsCustom([<cTagName>|<nIndex>]) -> lCustom

Checks if an index is created in descending order

OrdIsDescend() --> lIsDescend

Checks if a order is a SubIndex order

OrdIsSubIndex([<cTagName>|<nIndex>]) -> lSubIndex

Checks if an index is unique

OrdIsUnique() --> lIsUnique

Returns the index expression of an index.

OrdKey( [<cTagName>|<nIndex>] ) --> cIndexKey

Manually add key value to a custom order

OrdKeyAdd([<cTagName>|<nIndex>]) -> lSuccess

Determines the relative logical record number of the current data record within the indexed database.

OrdKeyNo( [<nIndex> | <cTagName>] ) --> nRelativeRecord

Manually remove key value from a custom order

OrdKeyRemove([<cTagName>|<nIndex>]) -> lSuccess

Determines a list of all tag names relating to the current work area.

OrdList() --> aTagNames

Activate one or more indexes in a work area.

OrdListAdd( <cIndexFile> [,<cTagName>] ) --> NIL

Closes all index files in a work area.

OrdListClear() --> NIL

Rebuilds open index files in a work area.

OrdListRebuild() --> NIL

Returns the index name from the list of open indexes.

OrdName( [<nIndex>] ) --> cTagName

Returns the position of an index in the index list based on the index name.

OrdNumber( [<cTagName>] ) --> nIndexOrder

Transforms an existing order to a custom order for manual key manipulation

OrdSetCustom([lSet]) -> lCustom

Sets the controlling index in a work area.

OrdSetFocus( [<cTagName>|<nIndex>] ) --> cLastIndexName

Search for a single or subset of records matching a specific wildcard pattern.

OrdWildSeek( <cSkeletonExpr> ) --> lMatch OrdWildSeek() -> nRecord

Rebuilds open index files in the current work area.

REINDEX [COMPACT]

Positions the record pointer based on the value of an index expression.

SEEK [LAST] <Expression> ORDER [TAG] <cTagName>|<nIndex> [IN <nWorkArea> | <cAlias> ] [SOFTSEEK]

Opens one or more index files in the current work area.

SET INDEX TO [<cIndexFiles,...>] [ORDER [TAG] <nIndex> | <cTagName> [ASCENDING | descending] [ADDITIVE]

Specifies the controlling index in the current work area or the work area specified.

SET ORDER TO [<nIndex>] | TAG <cTagName> [OF <cIndexfile>] [IN <nWorkArea> | <cAlias> ] [ASCENDING | descending]

Sets whether an index may contain multiple records with the same key value.

SET UNIQUE on | OFF | <lToggle>