<< Click to Display Table of Contents >> Navigation:  Support Classes > BtTable Class >   BtTable:OrderScope()

 

Purpose

 

 

Get/Set the boundaries for scoping key values in the controlling order.

 

 

 

Prototype

 

 

METHOD OrderScope ( kScope, uValue )  CLASS BtTable

 

 

 

Argument(s)

 

 

<kType>                A number specifying the top (TOPSCOPE) or bottom (BOTTOMSCOPE) boundary.

<uValue>                (Optional) The top or bottom range of key values that will be included in the controlling order's current scope.

 

 

 

 

Return

 

 

ARRAY                Current value of the Scope

 

 

 

Description

 

 

<uValue> must be an expression that matches the data type of the key expression in the controlling order If the current order consists of more than 1 segment, an array of values can be specified. Specifying <uValue> as NIL has the special effect of resetting the specified scope to its original default. The default top range is the first logical record in the controlling order, and the default bottom range is the last logical record. Omitting <uValue> will return the current scope and change nothing

NOTE

The range of values specified using BtTable:OrderScope() is inclusive.  In other words, the keys included in the scope will be greater than or equal the top boundary and less than or equal to the bottom boundary.

 

 

 

See Also

 

 

BtTable, BtTable:ClearOrderScope()