Instance Method

scanUpToCharactersFromSet:intoString:

Scans the string until a character from a given character set is encountered, accumulating characters into a string that’s returned by reference.

Declaration

- (BOOL)scanUpToCharactersFromSet:(NSCharacterSet *)set intoString:(NSString * _Nullable *)result;

Parameters

stopSet

The set of characters up to which to scan.

stringValue

Upon return, contains the characters scanned.

Return Value

YES if the receiver scanned any characters, otherwise NO.

If the only scanned characters are in the charactersToBeSkipped character set (which is the whitespace and newline character set by default), then returns NO.

Discussion

Invoke this method with NULL as stringValue to simply scan up to a given set of characters.

If no characters in stopSet are present in the scanner's source string, the remainder of the source string is put into stringValue, the receiver’s scanLocation is advanced to the end of the source string, and the method returns YES.

See Also

Scanning Characters and Strings

- scanCharactersFromSet:intoString:

Scans the string as long as characters from a given character set are encountered, accumulating characters into a string that’s returned by reference.

- scanString:intoString:

Scans a given string, returning an equivalent string object by reference if a match is found.

- scanUpToString:intoString:

Scans the string until a given string is encountered, accumulating characters into a string that’s returned by reference.