Carbon


ATSUClearFontFeatures

Header: ATSUnicode.h Carbon status: Supported

Removes font features from a style object.

OSStatus ATSUClearFontFeatures (
    ATSUStyle iStyle, 
    ItemCount iFeatureCount, 
    ATSUFontFeatureType iType[], 
    ATSUFontFeatureSelector iSelector[]
);
Parameter descriptions
iStyle

A reference to a valid style object whose font features you want to remove. You cannot pass NULL for this parameter.

iFeatureCount

The number of font features you want to remove. To remove all previously set font features, pass the constant kATSUClearAll in this parameter. In this case, the values in the iType and iSelector parameters will be ignored.

iType

An array of the feature types whose values you wish to remove. Each element in the array must contain a valid feature type that identifies a font feature whose value you want to remove.

iSelector

An array of the feature selectors whose values you wish to remove. Each element in the array must contain a valid feature selector that specifies the setting for the font feature that you want to remove.

function result

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

DISCUSSION

The ATSUClearFontFeatures function removes those font features that are identified by the feature selector and type constants in the iSelector and iType arrays. It replaces them with their font-defined default values. If you wish to remove all previously set font features from a style object, pass kATSUClearAll in the iFeatureCount parameter.

To remove font variations from a style object, call the function ATSUClearFontVariations. To remove style run attribute, font feature, and font variation values from a style object, call the function ATSUClearStyle.

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)