Carbon


ATSUGetIndFontVariation

Header: ATSUnicode.h Carbon status: Supported

Obtains information about a font variation.

OSStatus ATSUGetIndFontVariation (
    ATSUFontID iFont, 
    ItemCount iVariationIndex, 
    ATSUFontVariationAxis *oATSUFontVariationAxis, 
    ATSUFontVariationValue *oMinimumValue, 
    ATSUFontVariationValue *oMaximumValue, 
    ATSUFontVariationValue *oDefaultValue
);
Parameter descriptions
iFont

The ID of the font whose font variation you want information about.

iVariationIndex

An index of the font variation you wish information about. Pass a value between 0 and one less than the count passed back in the function ATSUCountFontVariations.

oATSUFontVariationAxis

On return, a pointer to the axis of the font variation. You cannot pass NULL for this parameter.

oMinimumValue

On return, a pointer to the minimum value of the variation axis. You cannot pass NULL for this parameter.

oMaximumValue

On return, a pointer to the maximum value of the variation axis. You cannot pass NULL for this parameter.

oDefaultValue

On return, a pointer to the default value of the variation axis. You cannot pass NULL for this parameter.

function result

A result code. The result code kATSUInvalidFontErr indicates that the ID does not correspond to any installed font.

DISCUSSION

The ATSUGetIndFontVariation function obtains the axis and default, minimum, and maximum values for an indexed font variation.

Some fonts are capable of generating a wide range of stylistic changes. Such a font contains font variation axes, each of which describes a particular stylistic attribute and the range of values that the font can use. Each axis has a minimum, maximum, and default value. The minimum and maximum values determine the range of values that the variation axis covers. A font may also name specific values along a variation axis as font instances.

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)