CFStringGetPascalStringPtrHeader: CFString.h

Quickly obtains a pointer to a Pascal buffer containing the characters of a CFString object in a given encoding.

ConstStringPtr CFStringGetPascalStringPtr (
    CFStringRef theString, 
    CFStringEncoding encoding
);
theString

Pass a reference to the CFString object whose contents you wish to access.

encoding

Pass a constant of type CFStringEncoding that indentifies the encoding to which the character contents of the CFString object should be converted.

function result

A pointer to a Pascal string buffer or NULL if the internal storage of the CFString does not allow this to be returned efficiently.

DISCUSSION

This function either returns the requested pointer immediately, with no memory allocations and no copying, in constant time, or returns NULL. If the latter is the result, call an alternative function such as CFStringGetPascalString function to extract the characters.

Whether or not this function returns a valid pointer or NULL depends on many factors, all of which depend on how the string was created and its properties. In addition, the function result might change between different releases and on different platforms. So do not count on receiving a non-NULL result from this function under any circumstances.


© 1999 Apple Computer, Inc. — (Last Updated 9/15/99)