Click or drag to resize

OrdKeyCount Function

Return the number of keys in an order.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.08
Syntax
 FUNCTION OrdKeyCount(
	 uOrder AS USUAL,
	 cIndexFile 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 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.

Return Value

Type: Usual
Remarks
OrdKeyCount() counts the keys in the specified order and returns the result as a numeric value.  If the order is not conditional and no scope has been set for it, OrdKeyCount() is identical to RecCount(), returning the number of records in the database file.  However, for a conditional order, there may be fewer keys than there are records, since some records may not meet the order's for condition or may not fall inside the scope specified by OrdScope() — in counting the keys, OrdKeyCount() respects the currently defined scope and for condition. 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.
If there is no order in operation, the return value will be 0 and not the value of RecCount().
Examples
This example demonstrates using OrdKeyCount() with various orders.
X#
USE customer
// Assume 1000 total records,
// 500 less than thirty years old, and
// 895 making less than 50,000
? RecCount()                                        // Result: 1000
? OrdKeyCount()                        // Result: 0
INDEX ON Age TO Age
INDEX ON First TO First FOR Age < 30
INDEX ON Last TO Last FOR Salary < 50000
// Age is the controlling order
SET INDEX TO Age, First, Last
? RecCount()                                        // Result: 1000
? OrdKeyCount()                        // Result: 1000
? OrdKeyCount("First")                // Result: 500
? OrdKeyCount(3)                        // Result: 895
See Also