String.Compare

From Xojo Documentation

Revision as of 14:00, 26 January 2021 by PLefebvre (talk | contribs) (Notes: Changed from constant to enum for CaseSensitive in description)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Method

String.Compare(other As String, Optional compare As ComparisonOptions = comparisonOptions.CaseInsensitive, Optional locale As Locale = Nil) As Integer

Supported for all project types and targets.

Compares a String value with another string value. A non-empty String is always greater than an empty String. By default, a case-insensitive comparison is done. Returns a negative integer if the value is less than other, 0 if the two values are equal, and a positive integer if the value is greater than other.

Parameters

Parameter Description
other The String to compare with the original String.
compare (Optional) Use the ComparisonOptions enum.
locale (Optional) The locale to use for comparisons. By default an invariant locale (not dependent on the system settings) is used.

Notes

By default this performs a case-insensitive comparison. To do a case-sensitive comparison, supply the ComparisonOptions.CaseSensitive enum value to the compare parameter.

By default comparisons are done in an invariant locale (i.e. not dependent on the user's preferences). The locale parameter can be used to specify an explicit locale to do comparisons in.

Exceptions

Sample Code

Compare two String values:

Var dog As String = "Dog"
Var cat As String = "Cat"

Var result As Integer
result = dog.Compare(cat)

// result > 0