String..::..LocaleCompare Method (String, String, LocaleOptions)
The localeCompare() method returns a number indicating whether a reference string comes before or after or is the same as the given string in sort order.
The new locales and options arguments let applications specify the language whose sort order should be used and customize the behavior of the function. In older implementations, which ignore the locales and options arguments, the locale and sort order used are entirely implementation dependent.
Namespace:
SystemAssembly: Bridge (in Bridge.dll)
Syntax
public int LocaleCompare( string compareString, string locales, LocaleOptions options )
Public Function LocaleCompare ( _ compareString As String, _ locales As String, _ options As LocaleOptions _ ) As Integer
public: int^ LocaleCompare( String^ compareString, String^ locales, LocaleOptions^ options )
Parameters
- compareString
- Type: System..::..String
The string against which the referring string is comparing
- locales
- Type: System..::..String
A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the locales argument, see the Intl page. The following Unicode extension keys are allowed:
- options
- Type: System..::..LocaleOptions
An object with some or all of the following properties: