![]() |
CFStringCreateWithPascalStringNoCopy | Header: CFString.h |
Creates a CFString object from an external Pascal string buffer that might serve as the backing store for the object.
CFStringRef CFStringCreateWithPascalStringNoCopy ( CFAllocatorRef alloc, ConstStringPtr pStr, CFStringEncoding encoding, CFAllocatorRef contentsDeallocator );
Pass a reference to an allocator to be used to create the CFString object or pass NULL to request the default allocator.
Pass a pointer to the Pascal string to be used to create the CFString object.
Pass an enum constant of type CFStringEncoding that specifes the encoding of the characters in the Pascal string.
Pass a reference to the allocator to use to deallocate the external string buffer when it is no longer needed. You can also pass NULL to request the default allocator for this purpose. If the buffer does not need to be deallocated, or if you want to assume responsiblity for deallocating the buffer (and not have the CFString object deallocate it), pass kCFAllocatorNull.
A reference to an immutable CFString object or NULL if there was a problem creating the object.
The CFStringCreateWithPascalString function creates an immutable CFString objects from the character contents of a Pascal string (after stripping off the initial length byte).
Unless the situation warrants otherwise, the created object does not copy the external buffer to internal storage but instead uses the buffer as its backing store. However, you should never assume that the object is using the external buffer since the object might copy the buffer to internal storage or even dump the buffer altogether and store the characters in another way.
The function includes a contentsDeallocator parameter with which to specify an allocator to use for deallocating the external buffer when the CFString object is deallocated. If you want to assume responsibility for deallocating this memory, specify kCFAllocatorNull for this parameter.
If at creation time the CFString object decides it can't use the buffer, and there is an allocator specified in the contentsDeallocator parameter, it will use this allocator to free the buffer at that time.