Click or drag to resize

OrdFor Function

X#
Return the for condition of an order.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax
 FUNCTION OrdFor(
	uOrder,
	cIndexFile,
	cFor
) AS USUAL CLIPPER
Request Example View Source

Parameters

uOrder (Optional)
Type: Usual
The name of the order whose for condition you want to obtain or a number representing its position in the order list.
Using the order name is the preferred method since the position may be difficult to determine using multiple-order index files. Invalid values are ignored.
cIndexFile (Optional)
Type: Usual
The name of an index file, including an optional drive and directory (no extension should be specified).
Use this argument with cOrder to remove ambiguity when there are two or more orders with the same name in different index files.
If cIndexFile is not open by the current process, a runtime error is raised.
cFor (Optional)
Type: Usual

Return Value

Type: Usual
A string representing the for condition of the specified order.
If the order was not created with a for condition, the return value will be a NULL_STRING.
If the RDD does not support the for condition, it can either return a NULL_STRING or cause an error, depending on the RDD.
Remarks
Tip Tip
You can also obtain the for condition using of an order DBOrderInfo(DBOI_CONDITION, [cIndexFile], cOrder).
Examples