Click or drag to resize

OrdIsUnique Function

X#
Return the status of the unique flag for a given order.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax
 FUNCTION OrdIsUnique(
	uOrder,
	cIndexFile
) AS USUAL CLIPPER
Request Example View Source

Parameters

uOrder (Optional)
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 (Optional)
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
The status of the indicated order's unique flag as a logical value.
Remarks
By default, this function operates on the currently selected work area.
It can be made to operate on an unselected work area by specifying it within an aliased expression
Examples
This example shows the return value of OrdIsUnique() using various orders:
X#
1USE customer VIA "DBFCDX"
2INDEX ON LastName TAG Last UNIQUE
3INDEX ON FirstName TAG First
4INDEX ON AGE TO j:\test\tmp\age UNIQUE
5SET ORDER TO last
6? OrdIsUnique()            // Result: TRUE, for last
7? OrdIsUnique("First")        // Result: FALSE
8? OrdIsUnique("Age")        // Result: TRUE
See Also