Carbon


ATSUCopyLayoutControls

Header: ATSUnicode.h Carbon status: Supported

Copies the text layout attributes from a text layout object into an existing one.

OSStatus ATSUCopyLayoutControls (
    ATSUTextLayout iSource, 
    ATSUTextLayout iDest
);
Parameter descriptions
iSource

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

iDest

A reference to an initialized text layout object whose attributes you want to replace. You cannot pass NULL for this parameter.

function result

A result code.

DISCUSSION

The ATSUCopyLayoutControls function copies all text layout attributes from a text layout object, including unset values. Unset text layout attribute values are assigned the default values described in “Text Layout Attribute Tag Constants”.

ATSUCopyLayoutControls does not copy the contents of memory referenced by pointers or handles within reference constants. You are responsible for ensuring that this memory remains valid until the source text layout object is disposed of.

To copy text layout attributes in a single line of a text layout object, call the function ATSUCopyLineControls.

ATSUCopyLayoutControls may allocate 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)