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

DbServer.OrderScope Method (Typed)

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

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

Parameters

nScope
Type: Long
A number specifying the top (TOPSCOPE) or bottom (BOTTOMSCOPE) boundary.
uValue
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