Click or drag to resize

OrdKeyDel Function

Delete a key from a custom built order.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.08
Syntax
 FUNCTION OrdKeyDel(
	 uOrder AS USUAL,
	 cIndexFile AS USUAL,
	 xVal AS USUAL
) AS USUAL
View Source

Parameters

uOrder
Type: Usual
The name of the order or a number representing its position in the order list.  Using the order name is the preferred method since the position may be difficult to determine using multiple-order index files.  If omitted or NIL, the controlling order is assumed.
Specifying an invalid order, such as one that is not custom built, will raise a runtime error.
cIndexFile
Type: Usual
The name of an index file, including an optional drive and directory (no extension should be specified).  Use this argument with <cOrder> to remove ambiguity when there are two or more orders with the same name in different index files.
If <cIndexFile> is not open by the current process, a runtime error is raised.
xVal
Type: Usual

Return Value

Type: Usual
TRUE if successful; otherwise FALSE.
Remarks
A custom built order is one that is not automatically maintained by the DBFCDX driver.  You can determine if an order is custom built using DBOrderInfo(DBOI_CUSTOM, ...).  When you create such an order, it is initially empty.  You must manually add and delete keys using OrdKeyAdd() and OrdKeyDel(). OrdKeyDel() will fail if: The record pointer is positioned on an invalid record (for example, EOF() returns TRUE or the record pointer is positioned on a record that falls outside the orders' scope or for condition) The specified order is not custom built The specified order does not exist No order was specified and there is no controlling order By default, this function operates on the currently selected work area.  It will operate on an unselected work area if you specify it as part of an aliased expression.
Examples
This example creates a custom index, adds every fiftieth record to it, and deletes every hundredth record:
X#
USE customer VIA "DBFCDX"
// Create custom built order that is initially empty
INDEX ON LastName TO Last CUSTOM
// Add every 50th record
FOR n := 1 UPTO RecCount() STEP 50        
        GOTO n
        OrdKeyAdd()
NEXT
// Remove every 100th record
FOR n := 1 UPTO RecCount() STEP 100
        GOTO n
        OrdKeyDel()
NEXT
See Also