BtServer:IndexKey()

 

<< Click to Display Table of Contents >>

Navigation:  Server Classes > BtServer Class >

 

BtServer:IndexKey()

 

Previous pageReturn to chapter overviewNext page

 

Purpose

 

 

Return the key expression of the active order

 

 

 

Prototype

 

 

METHOD INDEXKEY ( nIndex )  CLASS BtServer

 

 

 

Argument(s)

 

 

nIndex  (Optional) Index number to get the info from. Defaults to current index

 

 

 

 

Return

 

 

STRING                the string represenation of the key expression

 

 

 

Description

 

 

This property return the index key expression as a string.

Multi-segment indexes have their segments seperated with commas.

Please note that this is not a regular VO expression, since multi-segment indexes may contain fields of different types, that can not be concatinated by VO without the proper conversion functions

 

 

 

See Also

 

 

BtServer, BtServer:OrderKeyVal(), BtServer:OrderInfo()