String Class Extensions

localeCompare() method

This function compares the sort order of two or more strings and returns the result of the comparison as a numeric value. This method compares in a locale-specific way. If the strings are equivalent, the return value is 0. If the original string value precedes the string value specified by the parameter, the return value is a negative value.

If the original string value comes after one in parameter, the return value is a positive value. See “Array Class Extensions” for more details about locale-specific string operations. Note, this functionality might not work correctly on certain platforms, which do not support appropriate functionality in kernel. In this case this function will perform as a regular string comparison with Unicode values.

public localeCompare(other:String [, caseInsensitive:Boolean]) : Number

Scaleform version: 3.0.65

Parameters
other:String – A string to compare with.

caseInsensitive:Boolean – An optional parameter that might be used to perform case-insensitive comparison. If the parameter is not specified then the comparison is case-sensitive.

See also: Array.sort