CFStringGetCharacterFromInlineBufferHeader: CFString.h

Obtains the Unicode character at a specific location in an in-line buffer.

UniChar CFStringGetCharacterFromInlineBuffer (
    CFStringInlineBuffer *buf, 
    CFIndex idx
);
buf

Pass a pointer to an initialized CFStringInlineBuffer structure. You should initialize the structure with the CFStringInitInlineBuffer function.

idx

Pass an integer of type CFIndex that specifies the location of a character in the in-line buffer buf. This index is relative to the range specified when the in-line buffer was created.

function result

A Unicode character.

DISCUSSION

The CFStringGetCharacterFromInlineBuffer function accesses one of the characters of a CFString object written to an in-line buffer. It is typically called from within a loop to access each character in the buffer in sequence. You should initialize the buffer with the CFStringInitInlineBuffer function. The in-line buffer functions, along with the CFStringInlineBuffer structure, give you fast access to the characters of a CFString object. The technique for in-line buffer access combines the convenience of one-at-a-time character access with the efficiency of bulk access.


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