Carbon


ATSUGetIndFontTracking

Header: ATSUnicode.h Carbon status: Supported

Determines the name code and value of an indexed font tracking.

OSStatus ATSUGetIndFontTracking (
    ATSUFontID iFont, 
    ATSUVerticalCharacterType iCharacterOrientation, 
    ItemCount iTrackIndex, 
    Fixed *oFontTrackingValue, 
    FontNameCode *oNameCode
);
Parameter descriptions
iFont

The ID of the font whose font tracking whose name code and value you want to determine.

iCharacterOrientation

The glyph orientation of the font tracking whose name code and value you want to determine. See “Glyph Orientation Constants” for a description of possible values. You must specify this value because there are different font trackings for different glyph orientations.

iTrackIndex

An index of the font tracking you want information about. Pass a value between 0 and one less than the count passed back in the function ATSUCountFontTracking.

oFontTrackingValue

On return, a pointer to the font tracking value corresponding to the specified index and character orientation.

oNameCode

On return, a pointer to the name code of the font tracking name. See “Font Name Code Constants” in the Font Manager for a description of possible values. 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

You should call the ATSUGetIndFontTracking function to iterate through the entries of a font tracking table to find the name code and value of an indexed font tracking. You can pass the value passed back in the oNameCode parameter to the function ATSUFindFontName to find the localized tracking name identified by this name code.

VERSION NOTES

Available beginning with ATSUI 1.1.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.6 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)