Navigation:  Classes > bArrayServer >

bArrayServer:OrderInfo()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Returns information about an order and optionally allows changes.

Class

bArrayServer

Type

Method

Syntax

<oArrayServer>:OrderInfo(

<iInfoType>,

[<uReserved>],

[<iOrderNo>],

[<uValueNew>]

) Æ uValue

Arguments

<iInfoType>The property that is to be returned and optionally changed. The following properties are supported:

 

Constant

Description

Value can be changed

DBOI_CONDITION

A string that indicates the FOR condition of the order.

No

DBOI_EXPRESSION

A string that indicates the key expression of the order.

 

Important note:
Only if the sort expression in the method bArrayServer:CreateOrder() was defined as a String this can be determined again. If the expression was defined as a Codeblock then a NULL_STRING is returned.

No

DBOI_ISCOND

A logical value that indicates whether the order contains a FOR condition.

No

DBOI_ISDESC

A logical value that indicates whether the order is descending or ascending.

No

DBOI_KEYCOUNT

A numeric value that indicates the number of keys in the order.

No

DBOI_KEYDEC

A numeric value that indicates the number of decimal places of key expression.

No

DBOI_KEYSINCLUDED

A numeric value that indicates the number of keys included in the order.

No

DBOI_KEYSIZE

A numeric value that indicates the length (including decimal point and decimal places) of key expression.

No

DBOI_KEYTYPE

A string that indicates the data type of key expression.

No

DBOI_NAME

A string that indicates the name of the order.

Yes

DBOI_NUMBER

A numeric value that indicates the position of the order within the list of opened orders.

No

DBOI_ORDERCOUNT

A numeric value that indicates the number of opened orders.

No

DBOI_POSITION

A numeric value that indicates the logical record number of the current record.

Yes

DBOI_RECNO

A numeric value that indicates the physical record number of the current record.

No

DBOI_SCOPEBOTTOM

A value that indicates the bottom boundary of the scope for the order.

Yes

DBOI_SCOPETOP

A value that indicates the top boundary of the scope for the order.

Yes

DBOI_SETCODEBLOCK

A code block that indicates the key expression for the order.

No

 

Data Type:Integer

 

<uReserved>Reserved argument. The value NIL must be indicated.
Data Type:NIL

 

<iOrderNo>Number of the order for which the property is to be returned or set respectively. If the argument is not indicated or is the value 0, the current active order is used.
Data Type:Integer

 

<uValueNew>The new value that is to be set for this property.
Data Type:Usual

Return Value

uValueThe current property value.
Data Type:Usual

Description

bArrayServer:OrderInfo() determines a property for the specified order and returns it. By using the argument <uValueNew> the property can be changed.

 


Page url: http://www.YOURSERVER.com/index.html?barrayserver_orderinfo.htm