Carbon


ATSUGetFontInstanceNameCode

Header: ATSUnicode.h Carbon status: Supported

Obtains the name code of a font instance.

OSStatus ATSUGetFontInstanceNameCode (
    ATSUFontID iFont, 
    ItemCount iInstanceIndex, 
    FontNameCode *oNameCode
);
Parameter descriptions
iFont

The ID of the font whose font instance you want to get name information for.

iInstanceIndex

An index of the font instance whose name code you want. Pass a value between 0 and one less than the count passed back in the function ATSUCountFontInstances.

oNameCode

On return, a pointer to the name code of the font instance 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. The result code kATSUNotSetErr indicates that the font has no name in its name table for the indicated font variation.

DISCUSSION

The ATSUGetFontInstanceNameCode function obtains the name code of a font instance. You can pass the value passed back in the oNameCode parameter to the function ATSUFindFontName to find the localized font instance name identified by this name code.

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)