RangeOfStringOptionsRangeLocale Method (aString, mask, searchRange, 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.

Original signature is '- (NSRange)rangeOfString:(NSString *)aString options:(NSStringCompareOptions)mask range:(NSRange)searchRange locale:(NSLocale *)locale'

Available in Mac OS X v10.5 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual NSRange RangeOfStringOptionsRangeLocale(
	NSString aString,
	NSStringCompareOptions mask,
	NSRange searchRange,
	NSLocale locale
)

Public Overridable Function RangeOfStringOptionsRangeLocale ( _
	aString As NSString, _
	mask As NSStringCompareOptions, _
	searchRange As NSRange, _
	locale As NSLocale _
) As NSRange

public:
virtual NSRange RangeOfStringOptionsRangeLocale(
	NSString^ aString, 
	NSStringCompareOptions mask, 
	NSRange searchRange, 
	NSLocale^ locale
)

Parameters

aString (NSString): The string for which to search. This value must not be nil.

mask (NSStringCompareOptions): A mask specifying search options. The following options may be specified by combining them with the C bitwise OR operator: NSCaseInsensitiveSearch, NSLiteralSearch, NSBackwardsSearch, and NSAnchoredSearch. See String Programming Guide for details on these options.

searchRange (NSRange): MISSING

locale (NSLocale): The locale to use when comparing the receiver with aString. If this value is nil, uses the current locale.

Return Value

An NSRange structure giving the location and length in the receiver of aString within aRange in the receiver, modulo the options in mask. The range returned is relative to the start of the string, not to the passed-in range. Returns {NSNotFound, 0} if aString is not found or is empty (@"").

Version Information

Available in Monobjc Bridge: 10.6 (For Mac OS X 10.6 and later), 10.5 (For Mac OS X 10.5 and later)

Assembly: Monobjc.Foundation (Module: Monobjc.Foundation)