Navigation:  Classes > bArrayServer >

bArrayServer:OrderKeyAdd()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Add a new key to an order.

Class

bArrayServer

Type

Method

Syntax

<oArrayServer>:OrderKeyAdd(

<iOrderNo>,

<uValue>,

<iRecNo>,

[<lAdaptRecords>]

) Æ lSuccess

Arguments

<iOrderNo>The position of the order to add. The position refers to the list of the open orders and is to be maintained by the developer.
Data Type:Integer

 

<uValue>Key value, which is to be added to the order.
Data Type:Usual

 

<iRecNo>Number of the record, in which the key value is defined as field value.
Data Type:Integer

 

<lAdaptRecords>Logical value, which indicates whether the record numbers of the already existing key values are to be adapted. As default the value FALSE is used.
Data Type:Logic

Return Value

lSuccessLogical value, which indicates whether the key value of the order could be added.
TRUEThe key value was added.
FALSEThe key value could not be added.
Data Type:Logic

Description

bArrayServer:OrderKeyAdd() adds an existing order a key value with the associated record number. If the key value is contained in the order already, the record number is added to the existing key value. The method is used by the class bArrayServer, in order to update an order.

See Also

bArrayServer:IndexOrd()

bArrayServer:OrderKeyDel()

bArrayServer:OrderKeyCount()

 


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