compare(_:options:)
Compares the string with the specified string using the given options.
Declaration
func compare(_ string: String, options mask: NSString.CompareOptions = []) -> ComparisonResultParameters
- string:
The string with which to compare the receiver.
This value must not be
nil. If this value isnil, the behavior is undefined and may change in future versions of macOS. - mask:
Options for the search—you can combine any of the following using a C bitwise OR operator: Caseinsensitive, Literal, Numeric. See 10000035i for details on these options.
Return Value
Returns an ComparisonResult value that indicates the lexical ordering. ComparisonResult.orderedAscending the receiver precedes aString in lexical ordering, ComparisonResult.orderedSame the receiver and aString are equivalent in lexical value, and ComparisonResult.orderedDescending if the receiver follows aString.
Discussion
This method is equivalent to invoking compare(_:options:range:) with a given mask as the options and the receiver’s full extent as the range.