localeCompare Method (Windows Scripting - JScript)

  • Article

 

Returns a value indicating whether two strings are equivalent in the current locale.

Syntax

stringVar.localeCompare(stringExp)

Arguments

  • stringVar
    Required. A String object or literal.

  • stringExp
    Required. String to compare to stringVar.

Remarks

The localeCompare performs a locale-sensitive string comparison of the stringVar and the stringExp and returns -1, 0, or +1, depending on the sort order of the system default locale.

If stringVar sorts before stringExp, localeCompare returns –1; if stringVar sorts after stringExp, +1 is returned. A return value of zero means that the two strings are equivalent.

Requirements

Version 5.5

Applies To: String Object (Windows Scripting - JScript)

See Also

toLocaleString Method (Windows Scripting - JScript)