Difference between revisions of "INDEXKEY()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
==Class==
 
Indexing
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the index key expression
 
Function to return the index key expression
Line 8: Line 4:
  
 
==Syntax==
 
==Syntax==
INDEXKEY(<expN>)
+
INDEXKEY([<expN>])
  
  
Line 16: Line 12:
  
 
==Description==
 
==Description==
The INDEXKEY() function is synonymous with the KEY() function.  The INDEXKEY() function returns the index key expression for index <expN>, or a null string if no index file exists.  When used in conjunction with the INDEXORDER() function, the INDEXKEY() function will return the index key expression of the master index.  The INDEXKEY() function always returns a character string in lower case.
+
The INDEXKEY() function is synonymous with the KEY() function.  The INDEXKEY() 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 INDEXKEY() function always returns a character string in lower case.
  
  
Line 27: Line 23:
 
? indexkey(indexorder())
 
? indexkey(indexorder())
 
dtos(date_paid) + str(amo_paid,11,2)
 
dtos(date_paid) + str(amo_paid,11,2)
index on lower(left(company,20)) to company
+
index on lower(left(company,20)) tag company
? indexkey(1)
+
? indexkey()
 
lower(left(company,20))
 
lower(left(company,20))
 
</code>
 
</code>
Line 34: Line 30:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
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

INDEXKEY([<expN>])


See Also

DBF(), FCOUNT(), FIELD(), FILTER(), FMT(), INDEXEXT(), INDEXORDER(), LEN(), NDX()


Description

The INDEXKEY() function is synonymous with the KEY() function. The INDEXKEY() 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 INDEXKEY() function always returns a character string in lower case.


Example

use accounts index acc_no, date_paid
? indexkey(1)
acc_no + dtos(date_rec)
set order to 2
? indexkey(indexorder())
dtos(date_paid) + str(amo_paid,11,2)
index on lower(left(company,20)) tag company
? indexkey()
lower(left(company,20))


Products

Recital Server, Recital