Functions and Directives

Function OrdIsCustom() Foundation

Checks if a order is a Custom order.

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

The return value is .T. (true) when the order is created as a custom 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 OrdIsCustom() is used to check if an index is created with the CUSTOM option of the INDEX command or was transformed to a custom index using the OrdSetCustom() function. Custom indexes are not automatically maintained by the Xbase++ runtime. However functions such as OrdKeyAdd() and OrdKeyRemove() can be used to manually add or remove index keys from/to the order.


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.