Difference between revisions of "KEY()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to return the index key expression
 
Function to return the index key expression
 
  
 
==Syntax==
 
==Syntax==
 
KEY([<expN>])
 
KEY([<expN>])
 
  
 
==See Also==
 
==See Also==
[[DBF()]], [[FCOUNT()]], [[FIELD()]], [[FILTER()]], [[FMT()]], [[INDEXEXT()]], [[INDEXORDER()]], [[LEN()]], [[NDX()]]
+
[[DBF()]], [[FCOUNT()]], [[FIELD()]], [[FILTER()]], [[INDEXEXT()]], [[INDEXORDER()]], [[LEN()]], [[NDX()]]
 
+
  
 
==Description==
 
==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.
 
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==
 
==Example==
Line 28: Line 24:
 
</code>
 
</code>
  
 
==Products==
 
Recital Server, Recital
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Indexing]]
 
[[Category:Indexing]]
 
[[Category:Indexing Functions]]
 
[[Category:Indexing Functions]]

Revision as of 08:41, 10 February 2012

Purpose

Function to return the index key expression

Syntax

KEY([<expN>])

See Also

DBF(), FCOUNT(), FIELD(), FILTER(), 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))