Function

CFStringFindCharacterFromSet

Query the range of the first character contained in the specified character set.

Declaration

Boolean CFStringFindCharacterFromSet(CFStringRef theString, CFCharacterSetRef theSet, CFRange rangeToSearch, CFStringCompareFlags searchOptions, CFRange *result);

Parameters

theString

The string to search.

theSet

The character set against which the membership of characters is checked.

rangeToSearch

The range of characters within theString to search. If the range location or end point (defined by the location plus length minus 1) are outside the index space of the string (0 to N-1 inclusive, where N is the length of the string), the behavior is undefined. The specified range must not exceed the length of the string. If the range length is negative, the behavior is undefined. The range may be empty (length 0), in which case no search is performed.

searchOptions

The option flags to control the search behavior. The supported options are kCFCompareBackwards and kCFCompareAnchored. If other option flags are specified, the behavior is undefined.

result

On return, a pointer to a CFRange structure (supplied by the caller) in which the search result is stored. Note that the length of this range could be more than 1 (if the character in question is a multi-byte character).

You may pass NULL if you don’t need this result.

Return Value

true if a character in the character set is found and result is filled, false otherwise.

See Also

Searching Strings

CFStringCreateArrayWithFindResults

Searches a string for multiple occurrences of a substring and creates an array of ranges identifying the locations of these substrings within the target string.

CFStringFind

Searches for a substring within a string and, if it is found, yields the range of the substring within the object's characters.

CFStringFindWithOptions

Searches for a substring within a range of the characters represented by a string and, if the substring is found, returns its range within the object's characters.

CFStringFindWithOptionsAndLocale

Returns a Boolean value that indicates whether a given string was found in a given source string.

CFStringGetLineBounds

Given a range of characters in a string, obtains the line bounds—that is, the indexes of the first character and the final characters of the lines containing the range.