Carbon


ATSUClearLineControls

Header: ATSUnicode.h Carbon status: Supported

Removes text layout attribute values from a line of text.

OSStatus ATSUClearLineControls (
    ATSUTextLayout iLayout, 
    UniCharArrayOffset iLineStart, 
    ItemCount iTagCount, 
    ATSUAttributeTag iTag[]
);
Parameter descriptions
iLayout

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

iLineStart

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

iTagCount

The number of attributes you want to remove. To remove all previously set text layout attributes, pass the constant kATSUClearAll in this parameter. In this case, the value in the iTag parameter will be ignored.

iTag

An array of valid tags that identify the text layout attribute values you want to remove. Each element in the array must contain a valid tag that corresponds to the text layout attribute value you want to remove. See “Text Layout Attribute Tag Constants” for a description of the Apple-defined text layout attribute tag constants. If you pass a style run attribute tag constant or an ATSUI-reserved tag in this parameter, ATSUClearLayoutControls returns the result code kATSUInvalidAttributeTagErr.

function result

A result code. You can remove unset attribute values from a line without a function error.

DISCUSSION

The ATSUClearLineControls function removes those text layout attribute values identified by the tag constants in the iTag array from a line. It replaces them with the default values described in “Text Layout Attribute Tag Constants”.

If you wish to remove all previously set text layout attribute values from a line, pass the constant kATSUClearAll in the iTagCount parameter. To remove all previously set text layout attributes from a text layout object, call the function ATSUClearLayoutControls.

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)