Functions and Directives

Function OrdIsSubIndex() Foundation

Checks if a order is a SubIndex order

OrdIsSubIndex([<cTagName>|<nIndex>]) -> lSubIndex
<cTagName> is a character string specifying the tag name of the index whose state <lSubIndex> is to be returned.
<nIndex> is a positive integer specifying the ordinal position within the work area of the index whose state <lSubIndex> is to be returned.

The return value is .T. (true) when the order is created as a subindex order, otherwise it is .F. (false). If no index file is open, the function returns .F. (false). If no value is specified for <nIndex> or <cTagName> , the state of the controlling index is returned.


The function OrdIsSubIndex() is used to check if an index is created with the SUBINDEX option of the INDEX command. A SubIndex is an index which contains a sub-set of records from the table of which the SubIndex is created for. The sub-set can be defined using Scopes, Filters or other another Index with a FOR or WHILE condition.


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.