[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 ORDFOR()
 Return the FOR expression of an order
------------------------------------------------------------------------------
 Syntax

     ORDFOR(<cOrderName> | <nOrder> [, <cOrderBagName>])
        --> cForExp

 Arguments

     <cOrderName> is the name of the target order whose cForExp is
     sought.

     <nOrder> is an integer that identifies the position in the order
     list of the target order whose cForExp is sought.

     <cOrderBagName> is the name of an order bag containing one or more
     orders.  You may specify <cOrderBagName> as the file name with or
     without the path name 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

     ORDFOR() returns a character expression, cForExp, that represents the
     FOR condition of the specified order.  If the order was not created
     using the FOR clause, the return value will be an empty string ("").  If
     the database driver does not support the FOR condition, it may either
     return an empty string ("") or raise an "unsupported function" error,
     depending on the driver.

 Description

     ORDFOR() is an order management function that returns the character
     string, cForExp, that represents the logical FOR condition of
     <cOrderName> or <nOrder>.

     Note:  ORDFOR(0) works as ORDFOR(INDEXORD()).

 Examples

     .  This example retrieves the FOR condition from an order:

        USE Customer NEW
        INDEX ON  Customer->Acct   ;
           TO  Customer      ;
           FOR Customer->Acct > "AZZZZZ"

        ORDFOR("Customer")      // Returns: Customer->Acct > "AZZZZZ"


See Also: INDEX ORDKEY() ORDCREATE() ORDNAME() ORDNUMBER()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson