Instance Method

scanUpToString:intoString:

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

Declaration

- (BOOL)scanUpToString:(NSString *)string intoString:(NSString * _Nullable *)result;

Parameters

stopString

The string to scan up to.

stringValue

Upon return, contains any characters that were scanned.

Return Value

YES if the receiver scans any characters, otherwise NO.

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

Discussion

If stopString is present in the receiver, then on return the scan location is set to the beginning of that string.

If stopString is the first string in the receiver, then the method returns NO and stringValue is not changed.

If the search string (stopString) isn't 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.

Invoke this method with NULL as stringValue to simply scan up to a given string.

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.

- 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.

- scanString:intoString:

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