NLCOLLATE2 [ MPE/iX Intrinsics Reference Manual ] MPE/iX 5.0 Documentation
MPE/iX Intrinsics Reference Manual
NLCOLLATE2
NM callable.
Collates two character strings according to the specified language
collating sequence and determines a lexical ordering. Designed to be
used with a COBOL program.
Syntax
____________________________________________________
| |
| I32 CA I32V CA I32V |
| result:=NLCOLLATE2(buffer1,len1,buffer2,len2,|
| I16V U16A U16A U16A |
| langnum,error,collseq); |
____________________________________________________
Parameters
result 32-bit signed integer by reference (required)
Returns the result of the collated character
strings (buffer1 and buffer2):
Value Meaning
0 buffer1 collates equal to buffer2
-1 buffer1 collates before buffer2
1 buffer1 collates after buffer2
The result is 0 if a nonzero error is returned.
buffer1 character array (required)
Passes the first character string to be collated.
len1 32-bit signed integer by value (required)
The length, in bytes, of the first character
string.
buffer2 character array (required)
Passes the second character string to be collated.
len2 32-bit signed integer by value (required)
The length, in bytes, of the second character
string.
langnum 16-bit signed integer by value (required)
Contains the language ID number, specifying the
collating sequence to be used.
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 bufferlength parameter
5 *NLS internal error
6 *NLS internal error
* Do not apply to calls with a langnum equal to 0
(NATIVE3000/XL).
collseq 16-bit unsigned integer array (optional)
Passes the native language collating sequence table
as returned by itemnum=11 of the NLINFO intrinsic.
If this parameter is present, langnum is ignored,
and this routine is more efficient. Refer to
itemnums 11 and 27 of the NLINFO intrinsic.
Related Information
Intrinsics NLFINDSTR, NLJUDGE, NLKEYCOMPARE, NLREPCHAR,
NLSCANMOVE, NLSWITCHBUF, NLTRANSLATE
Commands None
Manuals Native Language Programmer's Guide (32650-90022)
MPE/iX 5.0 Documentation