ORDKEY()
Return the key expression of an Order
- Syntax
-
- ORDKEY(<cOrderName> | <nOrder> [, <cOrderBagName>]) --> cExpKey
- Arguments
-
- <xOrder> It the name of the target order,or the numeric position of the order.
- <cOrderBagName> Name of the order bag.
- Returns
-
- <cExpKey> 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
USE Customer NEW via _DBFCDX
INDEX ON Customer->Acct ;
TO Customer ;
FOR Customer->Acct > "AZZZZZ"
Index on Custumer->Id to Cusid
ORDKEY( "Customer" ) // Returns: Customer->Acct
Set order to 2
ORDKEY() // Returns: Custumer->Id
- Status
- Started
- Compliance
-
- This function is Ca-Clipper compliant with one exception. If the <xOrder> paramter is not specified or <xOrder> is 0, the current active order is used.
- Platforms
-
- All
- Files
-
- Library is rdd
- See Also