X# Runtime and VO SDK Reference
X# Runtime and VO SDK Reference
VO Namespace
DbServer Class
DbServer Methods
DbServer.Append Method
DbServer.AppendDB Method
DbServer.AppendDelimited Method
DbServer.AppendSDF Method
DbServer.Average Method
DbServer.BLOBDirectExport Method
DbServer.BLOBDirectGet Method
DbServer.BLOBDirectImport Method
DbServer.BLOBDirectPut Method
DbServer.BLOBExport Method
DbServer.BLOBGet Method
DbServer.BLOBImport Method
DbServer.BLOBRootGet Method
DbServer.BLOBRootLock Method
DbServer.BLOBRootPut Method
DbServer.BLOBRootUnlock Method
DbServer.ClearFilter Method
DbServer.ClearIndex Method
DbServer.ClearLocate Method
DbServer.ClearOrderScope Method
DbServer.ClearRelation Method
DbServer.ClearScope Method
DbServer.Close Method
DbServer.Commit Method
DbServer.ConstructUniqueAlias Method
DbServer.Continue Method
DbServer.CopyDB Method
DbServer.CopyDelimited Method
DbServer.CopySDF Method
DbServer.CopyStructure Method
DbServer.Count Method
DbServer.CreateIndex Method
DbServer.CreateOrder Method
DbServer.DataField Method
DbServer.Delete Method
DbServer.DeleteAll Method
DbServer.DeleteOrder Method
DbServer.Error Method
DbServer.Eval Method
DbServer.FIELDGET Method
DbServer.FieldGetBytes Method
DbServer.FieldGetFormatted Method
DbServer.FieldHyperLabel Method
DbServer.FieldInfo Method
DbServer.FieldName Method
DbServer.FieldPos Method
DbServer.FIELDPUT Method
DbServer.FieldPutBytes Method
DbServer.FieldSpec Method
DbServer.FieldStatus Method
DbServer.FieldSym Method
DbServer.FieldValidate Method
DbServer.FLOCK Method
DbServer.GetArray Method
DbServer.GetLocate Method
DbServer.GetLookupTable Method
DbServer.GoBottom Method
DbServer.GoTo Method
DbServer.GoTop Method
DbServer.INDEXKEY Method
DbServer.INDEXORD Method
DbServer.Info Method
DbServer.Join Method
DbServer.Locate Method
DbServer.LockCurrentRecord Method
DbServer.LockSelection Method
DbServer.NoIVarGet Method
DbServer.NoIVarPut Method
DbServer.Notify Method
DbServer.OrderDescend Method
DbServer.OrderInfo Method
DbServer.OrderIsUnique Method
DbServer.OrderKeyAdd Method
DbServer.OrderKeyCount Method
DbServer.OrderKeyDel Method
DbServer.OrderKeyGoTo Method
DbServer.OrderKeyNo Method
DbServer.OrderScope Method
DbServer.OrderSkipUnique Method
DbServer.Pack Method
DbServer.RDDINFO Method
DbServer.Recall Method
DbServer.RecallAll Method
DbServer.RecordInfo Method
DbServer.Refresh Method
DbServer.Reindex Method
DbServer.Relation Method
DbServer.Replace Method
DbServer.ResetNotification Method
DbServer.RLOCK Method
DbServer.RLockVerify Method
DbServer.Seek Method
DbServer.SELECT Method
DbServer.SetDataField Method
DbServer.SetFilter Method
DbServer.SetIndex Method
DbServer.SetOrder Method
DbServer.SetOrderCondition Method
DbServer.SetRelation Method
DbServer.SetSelectiveRelation Method
DbServer.Skip Method
DbServer.Sort Method
DbServer.Sum Method
DbServer.SuspendNotification Method
DbServer.Total Method
DbServer.UnLock Method
DbServer.Update Method
DbServer.Zap Method
Click or drag to resize

DbServer.OrderScope Method

X#
Set the boundaries for scoping key values in the controlling order.

Namespace:  VO
Assembly:  VORDDClasses (in VORDDClasses.dll) Version: 2.19
Syntax
Copy
 VIRTUAL METHOD OrderScope(
	nScope,
	uValue
) AS USUAL CLIPPER
Request Example View Source

Parameters

nScope (Optional)
Type: Usual
A number specifying the top (TOPSCOPE) or bottom (BOTTOMSCOPE) boundary.
uValue (Optional)
Type: Usual
The top or bottom range of key values that will be included in the controlling order's current scope. uValue can be an expression that matches the data type of the key expression in the controlling order or a code block that returns the correct data type. Omitting uValue or specifying it 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.

Return Value

Type: Usual
If uNewValue is not specified, DBServer:OrderScope() returns the current setting. If uNewValue is specified, the previous setting is returned.
Remarks
The range of values specified using DBServer: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.
Tip Tip
If you are using DbServer:OrderDescend() with Scopes, you need to swap the Top and Bottom scope values !
X#
Copy
1oServer:OrderScope (TOPSCOPE, cFrom)
2oServer:OrderScope (BOTTOMSCOPE, cTo)
3oServer:OrderDescend(,, TRUE)
4oServer:OrderScope (TOPSCOPE, cTo)
5oServer:OrderScope (BOTTOMSCOPE, cFrom)
Examples
This example illustrates using DBServer:OrderScope() to set various scoping limitations on an order. Although not shown in the examples below, the GoTop() or some other pointer mechanism, should be used immediately following the OrderScope() method calls to invoke the scope itself. Checking for :EOF after the GoTop() call will also let you know if in fact any records even matched the scope conditions:
X#
Copy
1oDBFr := Friends{}
2oDBFr:SetIndex("age")
X#
Copy
1oDBFr:OrderScope(BOTTOMSCOPE, 25)    // Make 25 the lowest age in range
2oDBFr:OrderScope(TOPSCOPE, 30)    // Make 30 the highest age in range
3LIST Age                    // Shows records with 25 <= Age <= 30
4oDBFr:OrderScope(BOTTOMSCOPE, 35)    // Change highest age to 35
5LIST Age                    // Shows records with 25 <= Age <= 35
6oDBFr:OrderScope(TOPSCOPE, NIL)    // Reset top boundary
7LIST Age                    // Shows records with Age <= 35
8oDBFr:OrderScope(BOTTOMSCOPE, NIL)    // Reset bottom boundary
9LIST Age                    // Shows all records
See Also