CFMutableCharacterSet Reference

Overview

CFMutableCharacterSet manages dynamic character sets. The basic interface for managing character sets is provided by CFCharacterSet. CFMutableCharacterSet adds functions to modify the contents of a character set.

You create a mutable character set object using either the CFCharacterSetCreateMutable or CFCharacterSetCreateMutableCopy function.

CFMutableCharacterSet is “toll-free bridged” with its Cocoa Foundation counterpart, NSMutableCharacterSet. This means that the Core Foundation type is interchangeable in function or method calls with the bridged Foundation object. Therefore, in a method where you see an NSMutableCharacterSet * parameter, you can pass in a CFMutableCharacterSetRef, and in a function where you see a CFMutableCharacterSetRef parameter, you can pass in an NSMutableCharacterSet instance. This capability also applies to concrete subclasses of NSMutableCharacterSet. See “Toll-Free Bridged Types” for more information on toll-free bridging.

Functions by Task

Creating a Mutable Character Set

• CFCharacterSetCreateMutable
• CFCharacterSetCreateMutableCopy

Adding Characters

• CFCharacterSetAddCharactersInRange
• CFCharacterSetAddCharactersInString

Removing Characters

• CFCharacterSetRemoveCharactersInRange
• CFCharacterSetRemoveCharactersInString

Logical Operations

• CFCharacterSetIntersect
• CFCharacterSetInvert
• CFCharacterSetUnion

Functions

CFCharacterSetAddCharactersInRange

Adds a given range to a character set.

void CFCharacterSetAddCharactersInRange (
   CFMutableCharacterSetRef theSet,
   CFRange theRange
);

CFCharacterSetAddCharactersInString

Adds the characters in a given string to a character set.

void CFCharacterSetAddCharactersInString (
   CFMutableCharacterSetRef theSet,
   CFStringRef theString
);

CFCharacterSetCreateMutable

Creates a new empty mutable character set.

CFMutableCharacterSetRef CFCharacterSetCreateMutable (
   CFAllocatorRef alloc
);

CFCharacterSetCreateMutableCopy

Creates a new mutable character set with the values from another character set.

CFMutableCharacterSetRef CFCharacterSetCreateMutableCopy (
   CFAllocatorRef alloc,
   CFCharacterSetRef theSet
);

CFCharacterSetIntersect

Forms an intersection of two character sets.

void CFCharacterSetIntersect (
   CFMutableCharacterSetRef theSet,
   CFCharacterSetRef theOtherSet
);

CFCharacterSetInvert

Inverts the content of a given character set.

void CFCharacterSetInvert (
   CFMutableCharacterSetRef theSet
);

CFCharacterSetRemoveCharactersInRange

Removes a given range of Unicode characters from a character set.

void CFCharacterSetRemoveCharactersInRange (
   CFMutableCharacterSetRef theSet,
   CFRange theRange
);

CFCharacterSetRemoveCharactersInString

Removes the characters in a given string from a character set.

void CFCharacterSetRemoveCharactersInString (
   CFMutableCharacterSetRef theSet,
   CFStringRef theString
);

CFCharacterSetUnion

Forms the union of two character sets.

void CFCharacterSetUnion (
   CFMutableCharacterSetRef theSet,
   CFCharacterSetRef theOtherSet
);

Data Types

CFMutableCharacterSetRef

A reference to a mutable character set object.

typedef struct __CFCharacterSet *CFMutableCharacterSetRef;