Function

CFAttributedStringGetString

Returns the string for an attributed string.

Declaration

CFStringRef CFAttributedStringGetString(CFAttributedStringRef aStr);

Parameters

aStr

The attributed string to examine.

Return Value

An immutable string containing the characters from aStr, or NULL if there was a problem creating the object. Ownership follows the The Get Rule.

Discussion

For performance reasons, the string returned will often be the backing store of the attributed string, and it might therefore change if the attributed string is edited. However, this is an implementation detail, and you should not rely on this behavior.

See Also

Creating a CFAttributedString

CFAttributedStringCreate

Creates an attributed string with specified string and attributes.

CFAttributedStringCreateCopy

Creates an immutable copy of an attributed string.

CFAttributedStringCreateWithSubstring

Creates a sub-attributed string from the specified range.

CFAttributedStringGetLength

Returns the length of the attributed string in characters.