Carbon


TXNGetFontDefaults

Header: MacTextEditor.h Carbon status: Supported

Makes a copy of the font descriptions for a given text object.

OSStatus TXNGetFontDefaults (
    TXNObject iTXNObject, 
    ItemCount *ioCount, 
    TXNMacOSPreferredFontDescription iFontDefaults[]
);
Parameter descriptions
iTXNObject

A variable of type TXNObject. Pass the text object for the document whose default font settings you want to copy.

ioCount

A pointer to a variable of type ItemCount. The first time you call TXNGetFontDefaults (see Discussion), the pointer does not need to be initialized. On return, ioCount specifies the number of font descriptions in the iFontDefaults array. The second time you call TXNGetFontDefaults, the ioCount parameter should point to the number of font descriptions in the iFontDefaults array.

iFontDefaults

An array of TXNMacOSPreferredFontDescription structures to be filled. On return, it contains the font descriptions for the text object. Pass NULL if you do not know how many font descriptions should be in the array.

function result

A result code.

DISCUSSION

You need to call this function twice: once to get the number of font default descriptions, and the second time to get the font default data.

AVAILABILITY

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


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)