Carbon


ATSUCopyLineControls

Header: ATSUnicode.h Carbon status: Supported

Copies text layout attributes from a line of a text layout object.

OSStatus ATSUCopyLineControls (
    ATSUTextLayout iSourceTextLayout, 
    UniCharArrayOffset iSourceLineStart, 
    ATSUTextLayout iDestTextLayout, 
    UniCharArrayOffset iDestLineStart
);
Parameter descriptions
iSourceTextLayout

A reference to an initialized text layout object that contains the line whose attribute values you want to copy. You cannot pass NULL for this parameter.

iSourceLineStart

The edge offset in backing store memory corresponding to the the beginning of the line whose attribute values you want to copy.

iDestTextLayout

A reference to the initialized text layout object containing the line whose attribute values you want to replace. This can be the same text layout object passed in the iSourceTextLayout parameter if you want to copy text layout attributes within a text layout object. You cannot pass NULL for this parameter.

iDestLineStart

The edge offset in backing store memory corresponding to the the beginning of the line whose attribute values you want to replace.

function result

A result code.

DISCUSSION

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

ATSUCopyLineControls 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 the text layout attributes of an entire text layout object, call the function ATSUCopyLayoutControls.

ATSUCopyLineControls 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.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)