<!--
{
  "availability" : [
    "iOS: 2.0.0 -",
    "iPadOS: 2.0.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 10.0.0 -",
    "tvOS: 9.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Foundation",
  "identifier" : "/documentation/Foundation/NSString/compare(_:options:range:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "Foundation"
    ],
    "preciseIdentifier" : "c:objc(cs)NSString(im)compare:options:range:"
  },
  "title" : "compare(_:options:range:)"
}
-->

# compare(_:options:range:)

Returns the result of invoking [`compare(_:options:range:locale:)`](/documentation/Foundation/NSString/compare(_:options:range:locale:)) with a `nil` locale.

```
func compare(_ string: String, options mask: NSString.CompareOptions = [], range rangeOfReceiverToCompare: NSRange) -> ComparisonResult
```

## Parameters

`string`

The string with which to compare the range of the receiver specified by `range`.

    This value must not be     `nil`    . If this value is     `nil`    , 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: `NSCaseInsensitiveSearch`, `NSLiteralSearch`, `NSNumericSearch`.

    See     [String Programming Guide](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Strings/introStrings.html#//apple_ref/doc/uid/10000035i)     for details on these options.

`rangeOfReceiverToCompare`

The range of the receiver over which to perform the comparison. The range must not exceed the bounds of the receiver.
  
  > Important:
  > Raises an `NSRangeException` if `range` exceeds the bounds of the receiver.

## Return Value

Returns an [`ComparisonResult`](/documentation/Foundation/ComparisonResult) value that indicates the lexical ordering. [`ComparisonResult.orderedAscending`](/documentation/Foundation/ComparisonResult/orderedAscending) the receiver precedes `aString` in lexical ordering, [`ComparisonResult.orderedSame`](/documentation/Foundation/ComparisonResult/orderedSame) the receiver and `aString` are equivalent in lexical value, and [`ComparisonResult.orderedDescending`](/documentation/Foundation/ComparisonResult/orderedDescending) if the receiver follows `aString`.

## Discussion

This method is equivalent to invoking [`compare(_:options:range:locale:)`](/documentation/Foundation/NSString/compare(_:options:range:locale:)) with a `nil` locale.

> Important:
> When working with text that’s presented to the user, use the ``doc://com.apple.foundation/documentation/Foundation/NSString/localizedStandardCompare(_:)`` instead, or use the ``doc://com.apple.foundation/documentation/Foundation/NSString/compare(_:options:range:locale:)`` method, passing the user’s locale.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)