ORDKEY()
Return the key expression of an Order
- Syntax
-
- ORDKEY(<cOrderName> | <nOrder>
- [, <cOrderBagName>]) --> cExpKey
- Arguments
-
- <cOrderName> is the name of an Order, a logical ordering of a database.
- <nOrder> is an integer that identifies the position in the Order List of the target Order whose cExpKey is sought.
- <cOrderBagName> is the name of a disk file containing one or more Orders. You may specify <cOrderBagName> as the filename with or without the pathname or appropriate extension. If you do not include the extension as part of <cOrderBagName> HARBOUR uses the default extension of the current RDD.
- Returns
-
- Returns a character string, cExpKey.
- Description
-
- ORDKEY() is an Order management function that returns a character expression, cExpKey, that represents the key expression of the specified Order.
- You may specify the Order by name or with a number that represents its position in the Order List. Using the Order name is the preferred method.
- The active RDD determines the Order capacity of an Order Bag. The default DBFNTX and the DBFNDX drivers only support single-Order Bags, while other RDDs may support multiple-Order Bags (e.g., the DBFCDX and DBFMDX drivers).
Examples
This example retrieves the index expression from an Order:
USE Customer NEW
INDEX ON Customer->Acct ;
TO Customer ;
FOR Customer->Acct > "AZZZZZ"
ORDKEY( "Customer" ) // Returns: Customer->Acct
Tests
- Status
- Started
- Compliance
-
- Platforms
-
- All
- Files
-
- Library is rdd
- See Also