IdxCollate Function

 FUNCTION IdxCollate(
	uIndex,
	nIndex,
	uArea
) AS STRING CLIPPER

[ClipperCallingConventionAttribute(new string[] { ... })]
public static string IdxCollate(
	Usual uIndex = default,
	Usual nIndex = default,
	Usual uArea = default
)

Parameters

uIndex (Optional)

Type: Usual
Specifies the name of the compound index file. The compound index file you specify can be the structural compound index file automatically opened with the table or an independent compound index file.

nIndex (Optional)

Type: Usual
Specifies the index or index tag for which IDXCOLLATE( ) returns the collating sequence. IDXCOLLATE( ) returns the collating sequence for indexes and index tags in the following order as nIndexNumber increases from 1 to the total number of open index files and index tags:
Collating sequences for single-entry .idx index files (if any are open) are returned first.
The order in which the single-entry index files are included in Use or Set Index determines how the collating sequences are returned.
Collation sequences for tags in the structural compound index (if one is present) are returned next. The collating sequences are returned for the tags in the order in which the tags are created in the structural compound index.
Collating sequences for tags in any open independent compound indexes are returned last. The collation sequences are returned for the tags in the order in which the tags are created in the independent compound indexes. The empty string is returned if nIndexNumber is greater than the total number of open index files.

uArea (Optional)

Type: Usual
Specifies the work area number of the table for which the lock status is returned. If you omit cTableAlias and nWorkArea, the collation sequence is returned for the table open in the current work area.
Or
Specifies the alias of the table for which the lock status is returned. An "Alias not found" error message is generated if you specify an alias of a table that isn't open.

Return Value

Reference