Difference between revisions of "CANDIDATE()"
Yvonne.milne (Talk | contribs) m (1 revision) |
Yvonne.milne (Talk | contribs) |
||
| Line 1: | Line 1: | ||
==Purpose== | ==Purpose== | ||
Function to determine whether an index tag is a candidate index tag. | Function to determine whether an index tag is a candidate index tag. | ||
| − | |||
==Syntax== | ==Syntax== | ||
CANDIDATE([<expN1>][,<expN2> | <expC>]) | CANDIDATE([<expN1>][,<expN2> | <expC>]) | ||
| − | |||
==See Also== | ==See Also== | ||
| − | [[ALIAS()]], [[INDEX | + | [[ALIAS()]], [[INDEX]], [[SELECT()]], [[SEQNO()]], [[SYNCNUM]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]], [[UNIQUE()]] |
| − | + | ||
==Description== | ==Description== | ||
| Line 15: | Line 12: | ||
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. | 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== | ==Example== | ||
| Line 25: | Line 21: | ||
endif | endif | ||
</code> | </code> | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Indexing]] | [[Category:Indexing]] | ||
[[Category:Indexing Functions]] | [[Category:Indexing Functions]] | ||
Revision as of 12:56, 10 February 2012
Contents
Purpose
Function to determine whether an index tag is a candidate index tag.
Syntax
CANDIDATE([<expN1>][,<expN2> | <expC>])
See Also
ALIAS(), INDEX, SELECT(), SEQNO(), SYNCNUM, TAG(), TAGCOUNT(), TAGNO(), UNIQUE()
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
