MPE/iX Intrinsics Reference Manual (32650-90905)

Chapter 9 553
Command Definitions (MAIL-PUTJCW)
NLKEYCOMPARE
collates after the specified key). This means that the
FREAD call found a record whose key follows the specified
range. No records matching
generickey follow.
langnum 16-bit signed integer by value (required)
Contains the language ID number, specifying the collating sequence to be
used for the compare.
error 16-bit unsigned integer array (required)
Returns two elements: the first element is the error number; the second
element is reserved and always returns 0. The possible error number
values are:
Value Meaning
0
Successful
1 *NLS not installed
2 *Specified language not configured
3 Invalid collating table entry
4 Invalid length parameter
5 *NLS internal error
6 *NLS internal error
7 Value of
length1 not less than length2
* Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
collseq 16-bit unsigned integer array (optional)
Passes the collating sequence table as returned by NLINFO item 11. If this
parameter is present,
langnum is ignored, and this routine is much more
efficient.
Operation Notes
Use NLKEYCOMPARE when reading a KSAM file in key sequential order in combination with
FREAD, and after a FFINDBYKEY call.
The NLKEYCOMPARE intrinsic lets a program determine whether a generic key search found
an exact match (that is, the generic key is exactly equal to the beginning of the key), or
whether the keys are different only because of priority (for example, uppercase versus
lowercase or accent). It also lets the program determine whether an exactly matching key
could be farther along the key sequence.
Related Information
Intrinsics NLCOLLATE, NLREPCHAR, NLSCANMOVE,
NLSWITCHBUF, NLSTRANSLATE
Manual Native Language Programmer's Guide