CANDIDATE()

Class

Indexing

Purpose

Function to determine whether an index tag is a candidate index tag.

Syntax

CANDIDATE([<expN1>][,<expN2> | <expC>])

See Also

ALIAS(), SELECT(), TAG(), TAGCOUNT(), TAGNO()

Description

The CANDIDATE() function is used to determine whether an index tag is a candidate index tag. The number of the index tag to be examined can optionally be specified in <expN1>. If <expN> is not specified, the CANDIDATE() function will operate on the master index tag of the currently active table. If the tag number, <expN>, is specified, the CANDIDATE() function can be used on tables other than the currently active table by specifying either the relevant workarea number, <expN2>, or the alias name of the table, <expC>.

NOTE: A candidate index tag is an index tag that is a likely candidate to become the primary index tag as it does not contain any null or duplicate values.

Example

if tagcount() > 0
    for i = 1 to tagcount()
        ? "Candidate status for " + tag() + " is " + ltos(candidate(i))
    next
endif

Products

Recital Database Server, Recital Mirage Server, Recital Terminal Developer