Difference between revisions of "KEY()"
From Recital Documentation Wiki
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
Function to return the index key expression | Function to return the index key expression | ||
| Line 8: | Line 4: | ||
==Syntax== | ==Syntax== | ||
| − | KEY(<expN>) | + | KEY([<expN>]) |
| Line 16: | Line 12: | ||
==Description== | ==Description== | ||
| − | The KEY() function is synonymous with the INDEXKEY() function. The KEY() function returns the index key expression for index <expN> | + | The KEY() function is synonymous with the INDEXKEY() function. The KEY() function returns the index key expression for the master index or index <expN> if specified. A null string is returned if no such index exists. The KEY() function always returns a character string in lower case. |
| Line 27: | Line 23: | ||
? key(indexorder()) | ? key(indexorder()) | ||
dtos(date_paid) + str(amo_paid,11,2) | dtos(date_paid) + str(amo_paid,11,2) | ||
| − | index on lower(left(company,20)) | + | index on lower(left(company,20)) tag company |
| − | ? key( | + | ? key() |
lower(left(company,20)) | lower(left(company,20)) | ||
</code> | </code> | ||
| Line 34: | Line 30: | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital Server, Recital |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Indexing]] | [[Category:Indexing]] | ||
[[Category:Indexing Functions]] | [[Category:Indexing Functions]] | ||
Latest revision as of 13:05, 7 January 2010
Purpose
Function to return the index key expression
Syntax
KEY([<expN>])
See Also
DBF(), FCOUNT(), FIELD(), FILTER(), FMT(), INDEXEXT(), INDEXORDER(), LEN(), NDX()
Description
The KEY() function is synonymous with the INDEXKEY() function. The KEY() function returns the index key expression for the master index or index <expN> if specified. A null string is returned if no such index exists. The KEY() function always returns a character string in lower case.
Example
use accounts index acc_no, date_paid ? key(1) acc_no + dtos(date_rec) set order to 2 ? key(indexorder()) dtos(date_paid) + str(amo_paid,11,2) index on lower(left(company,20)) tag company ? key() lower(left(company,20))
Products
Recital Server, Recital
