Difference between revisions of "INDEXORDER()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to return the currently selected master index number
 
Function to return the currently selected master index number
 
  
 
==Syntax==
 
==Syntax==
 
INDEXORDER([<workarea | alias>])
 
INDEXORDER([<workarea | alias>])
 
  
 
==See Also==
 
==See Also==
[[CLOSE INDEX]], [[CREATE VIEW]], [[FIND]], [[IFILECOUNT()]], [[INDEX]], [[INDEXEXT()]], [[INDEXKEY()]], [[LOOKUP()]], [[NDX()]], [[ORDER()]], [[REINDEX]], [[RLOOKUP()]], [[SEEK]], [[SET CACHELOAD]], [[SET DCACHE]], [[SET ICACHE]], [[SET INDEX]], [[SET ORDER]], [[SYS()]], [[USE]]
+
[[CLOSE INDEX]], [[CREATE VIEW]], [[IFILECOUNT()]], [[INDEX]], [[INDEXEXT()]], [[INDEXKEY()]], [[LOOKUP()]], [[NDX()]], [[ORDER()]], [[REINDEX]], [[RLOOKUP()]], [[SEEK]], [[SET INDEX]], [[SET ORDER]], [[SYS()]], [[USE]]
 
+
  
 
==Description==
 
==Description==
 
The INDEXORDER() function returns the currently selected master index number as specified with the SET ORDER TO command.  If no index files are selected, it returns -1.  If index file are open, and SET ORDER has been set to 0, the INDEXORDER() function returns 0.  If the optional <workarea | alias> is specified, then the function will operate in that <workarea | alias>.
 
The INDEXORDER() function returns the currently selected master index number as specified with the SET ORDER TO command.  If no index files are selected, it returns -1.  If index file are open, and SET ORDER has been set to 0, the INDEXORDER() function returns 0.  If the optional <workarea | alias> is specified, then the function will operate in that <workarea | alias>.
 
When used in conjunction with the NDX() or INDEXKEY() functions, the INDEXORDER() function will return the index file name or index key of the master index.  The INDEXORDER() function is synonymous with the ORDER() function.
 
When used in conjunction with the NDX() or INDEXKEY() functions, the INDEXORDER() function will return the index file name or index key of the master index.  The INDEXORDER() function is synonymous with the ORDER() function.
 
  
 
==Example==
 
==Example==
Line 26: Line 22:
 
</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 05:59, 10 February 2012

Purpose

Function to return the currently selected master index number

Syntax

INDEXORDER([<workarea | alias>])

See Also

CLOSE INDEX, CREATE VIEW, IFILECOUNT(), INDEX, INDEXEXT(), INDEXKEY(), LOOKUP(), NDX(), ORDER(), REINDEX, RLOOKUP(), SEEK, SET INDEX, SET ORDER, SYS(), USE

Description

The INDEXORDER() function returns the currently selected master index number as specified with the SET ORDER TO command. If no index files are selected, it returns -1. If index file are open, and SET ORDER has been set to 0, the INDEXORDER() function returns 0. If the optional <workarea | alias> is specified, then the function will operate in that <workarea | alias>. When used in conjunction with the NDX() or INDEXKEY() functions, the INDEXORDER() function will return the index file name or index key of the master index. The INDEXORDER() function is synonymous with the ORDER() function.

Example

use patrons index name, event
? indexorder()
         1
set order to 2
? indexorder()
         2