Carbon


ATSUCreateTextLayout

Header: ATSUnicode.h Carbon status: Supported

Creates an empty text layout object.

OSStatus ATSUCreateTextLayout (
    ATSUTextLayout *oTextLayout
);
Parameter descriptions
oTextLayout

On return, a pointer to a reference to a newly-created text layout object.

function result

A result code.

DISCUSSION

The ATSUCreateTextLayout function creates a text layout object containing only default text layout attribute values, described in “Text Layout Attribute Tag Constants”. The resulting text layout object contains no style runs or associated text.

Most ATSUI functions that operate on text layout objects require that they contain style runs and text. If you create an empty text layout object and then wish to associate style runs or text with it, call the functions ATSUSetRunStyle and ATSUSetTextPointerLocation or ATSUSetTextHandleLocation, depending upon whether you wish to assign text referenced by a handle or a pointer.

ATSUCreateTextLayout allocates memory in your application heap, unless you designate a different heap by calling the function ATSUCreateMemorySetting.

VERSION NOTES

Available beginning with ATSUI 1.0.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.5 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)