DbServer.IndexKey Method (Typed) | |
Return the key expression of a specified single-order index.
Namespace:
XSharp.VO.SDK
Assembly:
XSharp.VORDDClasses (in XSharp.VORDDClasses.dll) Version: 2.19
Syntax VIRTUAL METHOD IndexKey(
uOrder AS USUAL
) AS USUAL
public virtual Usual IndexKey(
Usual uOrder
)
Request Example
View SourceParameters
- uOrder
- Type: Usual
The name of an order, or the ordinal position of the order within the order list. A value of 0 specifies the controlling index, without regard to its actual position in the list.
Return Value
Type:
Usual
The key expression of the specified index as a string; if there is no corresponding order or the order name is not unique, the method returns a NULL_STRING.
Remarks
The key expression actually belongs to an order and not to an index file. When using single-order indexes, or when the order name uniquely identifies an order, requesting key information for an index with IndexKey() works. But this practice is not recommended, since the request may not work when a different driver is used.
See Also