Carbon


ATSUGetFontVariationValue

Header: ATSUnicode.h Carbon status: Supported

Obtains the value corresonding a particular font variation axis.

OSStatus ATSUGetFontVariationValue (
    ATSUStyle iStyle, 
    ATSUFontVariationAxis iFontVariationAxis, 
    ATSUFontVariationValue *oFontVariationValue
);
Parameter descriptions
iStyle

A reference to a style object whose font variation value you want to obtain. You cannot pass NULL for this parameter.

iFontVariationAxis

The font variation axis whose value you want to obtain. You can pass a font variation axis passed back from the function ATSUGetAllFontVariations in the oVariationAxes array to the function ATSUGetAttribute to determine the corresponding attribute value.

oFontVariationValue

On return, a pointer to the font variation axis. If this value has not been set, ATSUGetFontVariationValue passes back the font-defined default value and returns the result code kATSUNotSetErr. You cannot pass NULL for this parameter.

function result

A result code.

DISCUSSION

Before calling ATSUGetFontVariationValue, call the function ATSUGetAllFontVariations to obtain one of the font variation axes passed back in the oVariationAxes array. You should then pass the axis whose value you want to determine in the iATSUFontVariationAxis parameter of ATSUGetFontVariationValue.

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)