Carbon


ATSUClearFontVariations

Header: ATSUnicode.h Carbon status: Supported

Removes font variations from a style object.

OSStatus ATSUClearFontVariations (
    ATSUStyle iStyle, 
    ItemCount iAxisCount, 
    ATSUFontVariationAxis iAxis[]
);
Parameter descriptions
iStyle

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

iAxisCount

The number of font variations you want to remove. To remove all previously set font variations, pass the constant kATSUClearAll in this parameter. In this case, the value in the iAxes parameter will be ignored.

iAxis

An array of the variation axes whose values you wish to remove. Each element in the array must contain a valid variation axis that corresponds to the variation value you want to remove.

function result

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

DISCUSSION

The ATSUClearFontVariations function removes those font variations that are identified by variation axes in the iAxes array. It replaces them with their font-defined default values. If you wish to remove all font variations from a style object, pass kATSUClearAll in the iAxisCount parameter.

To remove font features from a style object, call the function ATSUClearFontFeatures. 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)