CANDIDATE( ) Function

Example   See Also

Returns true (.T.) if an index tag is a candidate index tag; otherwise, returns false (.F.).

Syntax

CANDIDATE([nIndexNumber] [, nWorkArea | cTableAlias])

Returns

Logical

Arguments

nIndexNumber

Specifies the number of the index tag for which CANDIDATE( ) returns the candidate status. CANDIDATE( ) returns the candidate status in the following order as nIndexNumber increases from 1 to the total number of structural compound and independent compound index tags:

1. Candidate status for each tag in the structural compound index (if one is present) is returned first. The candidate status is returned for the tags in the order in which the tags are created in the structural index.
   
   
2. Candidate status for each tag in any open independent compound indexes is returned last. The candidate status is returned for the tags in the order in which the tags are created in the independent compound indexes.

   If you omit nIndexNumber, CANDIDATE( ) checks the master controlling index tag to see if it's a candidate index tag. If there is no master controlling index tag, CANDIDATE( ) returns false (.F.).

nWorkArea

Specifies the work area of the index tag specified with nIndexNumber.

cTableAlias

Specifies the work area of the index tag specified with nIndexNumber.

If you omit nWorkArea and cTableAlias, CANDIDATE( ) checks the index tag in the currently selected work area to see if it's a candidate index tag.

Remarks

A candidate index tag is an index tag that can become the primary index tag because it doesn't contain null or duplicate values.