
Click above to get retro games delivered to your door ever month!
X-Hacker.org- CA-Clipper 5.2 . Drivers Guide - <b>ordkey() function</b>
[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
ORDKEY() function
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> CA-Clipper 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
Status: New
See also: ORDFOR(), ORDNAME(), ORDNUMBER()
See Also: ORDFOR() ORDNAME() ORDNUMBER()
Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson