Carbon


ATSUCreateAndCopyTextLayout

Header: ATSUnicode.h Carbon status: Supported

Creates a copy of a text layout object.

OSStatus ATSUCreateAndCopyTextLayout (
    ATSUTextLayout iTextLayout, 
    ATSUTextLayout *oTextLayout
);
Parameter descriptions
iTextLayout

A reference to the initialized text layout object whose contents you want to copy. You cannot pass NULL for this parameter.

oTextLayout

On return, a pointer to a reference to a newly-created text layout object containing the contents of the text layout object in the iTextLayout parameter. You cannot pass NULL for this parameter.

function result

A result code.

DISCUSSION

The ATSUCreateAndCopyTextLayout function creates a copy of the text layout attribute values, style runs, and soft line breaks text layout object passed in the iTextLayout parameter. This same text layout attribute values, style runs, and soft line breaks. ATSUCreateAndCopyTextLayout does not copy reference constants or layout caches.

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

VERSION NOTES

Available beginning with ATSUI 1.1.

AVAILABILITY

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


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