Purpose
Set the boundaries for scoped key values in the controlling order.
Class
Type
Method
Syntax
<oArrayServer>:OrderScope(
<iScope>,
[<uValueNew>]
) Æ uValue
Arguments
<iScope> | The boundary for that the scoped key value to be defined. The following boundaries are supported: |
Constant |
Description |
TOPSCOPE |
Defines the top boundary of the key values. |
BOTTOMSCOPE |
Defines the bottom boundary of the key values. |
Data Type: | Integer |
<uValueNew> | The key value that is to be set as boundary. If the argument is not specified, the key value for the boundary is cleared. |
Data Type: | Usual |
Return Value
uValue | If <uValueNew> is not specified, the current setting otherwise the previous setting is returned. |
Data Type: | Usual |
Description
bArrayServer:OrderScope() defines a range of key values within the active order. This means that record movements include only key values that are greater than or equal the top boundary and less than or equal to the bottom boundary.
Before the operation the server sends a NotifyIntentToMove message. After successful execution a NotifyFileChange message is sent.
See Also
bArrayServer:ClearOrderScope()
Page url: http://www.YOURSERVER.com/index.html?barrayserver_orderscope.htm