Carbon


ATSUClearLayoutControls

Header: ATSUnicode.h Carbon status: Supported

Removes text layout attributes from a text layout object.

OSStatus ATSUClearLayoutControls (
    ATSUTextLayout iLayout, 
    ItemCount iTagCount, 
    ATSUAttributeTag iTag[]
);
Parameter descriptions
iLayout

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

iTagCount

The number of attribute values you want to remove. To remove all previously set 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 text layout object without a function error.

DISCUSSION

The ATSUClearLayoutControls function removes those text layout attribute values identified by the tag constants in the iTag array from a text layout object. 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 text layout object, pass the constant kATSUClearAll in the iTagCount parameter. To remove all previously set text layout attributes from a line of text, call the function ATSUClearLineControls.

VERSION NOTES

Available beginningwith 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)