Carbon


ATSUGetFontIDs

Header: ATSUnicode.h Carbon status: Supported

Obtains a list of all the compatible fonts installed on the user’s system.

OSStatus ATSUGetFontIDs (
    ATSUFontID oFontIDs[], 
    ItemCount iArraySize, 
    ItemCount *oFontCount
);
Parameter descriptions
oFontIDs

An array of the fonts installed on the user’s system. Before calling ATSUGetFontIDs, pass a pointer to memory that you have allocated for this array. You should allocate enough memory to contain the count passed back in the oFontIDs parameter of the function ATSUFontCount. On return, an array of the ATSUI-compatible fonts that are installed on the user’s system.

iArraySize

The maximum number of fonts in the style object. Typically, this is equivalent to the number of fonts in the oFontIDs array.

oFontCount

On return, a pointer to the actual number of fonts that are installed on the user’s system. This may be greater than the value passed in the iArraySize parameter. You cannot pass NULL for this parameter.

function result

A result code.

DISCUSSION

The ATSUGetFontIDs function obtains a list of all the fonts on the user’s system that are compatible with ATSUI. See the discussion of the function ATSUFontCount for a description of incompatible fonts.

You should call ATSUGetFontIDs to rebuild your font menu when your application is brought to the foreground.

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)