NLCOLLATE

Syntax

             CA       CA       I16V          I16     I16V
  NLCOLLATE (buffer1, buffer2, bufferlength, result, langnum,
  
    U16A   U16A
    error, collseq);

Parameters

buffer1

character array (required)

Passes the first character string to be collated.

buffer2

character array (required)

Passes the second character string to be collated.

bufferlength

16-bit signed integer by value (required)

Passes the length (in bytes) of buffer1 and buffer2.

result

16-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.

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

Manual

Native Language Programmer's Guide