IndexKey Function | |
Return the key expression of a specified order.
Namespace:
XSharp.RT
Assembly:
XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax FUNCTION IndexKey(
nPosition
) AS STRING CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public static string IndexKey(
Usual nPosition = default
)
Request Example
View SourceParameters
- nPosition (Optional)
- Type: Usual
The position of the order in the order list of the work area.
A value of 0 specifies the controlling order, without regard to its actual position in the list.
Return Value
Type:
String
The key expression of the specified order.
If there is no corresponding order or if no database file is open, IndexKey() returns a NULL_STRING.
Remarks
This function is provided for compatibility only.
The recommended function for obtaining the key expression of an order is DBOrderInfo(DBOI_EXPRESSION,, nPosition).
Examples See Also