# ORDFOR()

Return the FOR expression of an Order

Syntax

  ORDFOR(<xOrder>[, <cOrderBagName>]) --> cForExp

Arguments

  <xOrder> It the name of the target order,or the numeric position of the order.
  <cOrderBagName> Name of the order bag.

Returns

  ORDFOR() returns a expression containing the FOR condition for an order.

Description

  This function returns a character string that is the expression for the FOR condition for the specified order.The order may be specified if <xOrder> is the name of the order.However,<xOrder> may be an numeric which represent the position in the order list of the desired Order.

Examples

          USE Tests NEW via _DBFCDX
          INDEX ON  Tests->Id ;
             TO  TESTS          ;
             FOR Tests->Id > 100

          ORDFOR( "Tests" )      // Returns: Tests->Id > 100
    Tests
          See examples

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

- ORDKEY()
- ORDCREATE()
- ORDNAME()
- ORDNUMBER()