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 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

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 the Order, or .

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"

Tests




Status

Started

Compliance


See Also