Click or drag to resize

OrdKey Function

X#
Return the key expression of an order.

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

Parameters

uOrder (Optional)
Type: Usual
The name of the order whose key expression 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.

Return Value

Type: Usual
A string representing the key expression of the specified order.
Remarks
Tip Tip
You can also obtain the key expression of an order using DBOrderInfo(DBOI_EXPRESSION, [cIndexFile], cOrder).
Examples