acet-str-collate (AutoLISP/Express Tools)

Compares for sort order.

Supported Platforms: AutoCAD for Windows only; not available in AutoCAD LT for Windows, or on Mac OS and Web

Signature

(acet-str-collate left right [matchCase])

left

Type: String

The first string to compare.

right

Type: String

The second string to compare.

matchCase

Type: T or nil

If provided and non-nil, indicates that case sensitive comparison should be used. Normally case is ignored.

Return Values

Type: Integer

Returns -1, 0 or 1 to indicate relative sorting order (left < right, left == right and left > right, respectively). Displays a usage message if either of the first two arguments are not strings.

Remarks

This function uses multibyte comparison appropriate for the current codepage.