Instance Method

range(of:options:)

Finds and returns the range of the first occurrence of a given string within the receiver, subject to given options.

Declaration

func range(of searchString: String, options mask: NSString.CompareOptions = []) -> NSRange

Parameters

searchString

The string to search for.

mask

A mask specifying search options. For possible values, see NSString.CompareOptions.

Return Value

An NSRange structure giving the location and length in the receiver of the first occurrence of

searchString,

modulo the options in mask. Returns {NSNotFound, 0} if

searchString

is not found or is empty ("").

Discussion

Invokes range(of:options:range:) with the options specified by mask and the entire extent of the receiver as the range.

NSString objects are compared by checking the Unicode canonical equivalence of their code point sequences. The length of the returned range and that of

searchString

may differ if equivalent composed character sequences are matched.

See Also

Finding Characters and Substrings

func contains(String)

Returns whether the receiver contains a given string by performing a case-sensitive, locale-unaware search.

func localizedCaseInsensitiveContains(String)

Returns whether the receiver contains a given string by performing a case-insensitive, locale-aware search.

func localizedStandardContains(String)

Returns whether the receiver contains a given string by performing a case and diacritic insensitive, locale-aware search.

func rangeOfCharacter(from: CharacterSet)

Finds and returns the range in the receiver of the first character from a given character set.

func rangeOfCharacter(from: CharacterSet, options: NSString.CompareOptions = [])

Finds and returns the range in the receiver of the first character, using given options, from a given character set.

func rangeOfCharacter(from: CharacterSet, options: NSString.CompareOptions = [], range: NSRange)

Finds and returns the range in the receiver of the first character from a given character set found in a given range with given options.

func range(of: String)

Finds and returns the range of the first occurrence of a given string within the receiver.

func range(of: String, options: NSString.CompareOptions = [], range: NSRange)

Finds and returns the range of the first occurrence of a given string, within the given range of the receiver, subject to given options.

func range(of: String, options: NSString.CompareOptions = [], range: NSRange, locale: Locale?)

Finds and returns the range of the first occurrence of a given string within a given range of the receiver, subject to given options, using the specified locale, if any.

func localizedStandardRange(of: String)

Finds and returns the range of the first occurrence of a given string within the receiver by performing a case and diacritic insensitive, locale-aware search.