Carbon


ATSUClearAttributes

Header: ATSUnicode.h Carbon status: Supported

Removes style run attributes from a style object.

OSStatus ATSUClearAttributes (
    ATSUStyle iStyle, 
    ItemCount iTagCount, 
    ATSUAttributeTag iTag[]
);
Parameter descriptions
iStyle

A reference to a valid style object whose attributes you wish to remove. You cannot pass NULL for this parameter.

iTagCount

The number of attributes you wish 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 style run attribute values you want to remove. See “Style Run Attribute Tag Constants” for a description of the Apple-defined style run attribute tag constants. If you pass a text layout attribute tag constants or an ATSUI-reserved tag constant in this parameter, ATSUClearAttributes returns the result code kATSUInvalidAttributeTagErr.

function result

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

DISCUSSION

The ATSUClearAttributes function removes those style run attribute values identified by the tag constants in the iTag array from a style object. It replaces them with the default values described in “Style Run Attribute Tag Constants”.

If you wish to remove all previously set style run attribute values from a style object, pass the constant kATSUClearAll in the iTagCount parameter. To remove all previously set style run attribute, font feature, and font variation values from a style object, call the function ATSUClearStyle. To remove all previously set font variation values from a style object, call the function ATSUClearFontVariations. To remove all previously set font feature types and selectors from a style object, call the function ATSUClearFontFeatures.

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)