Carbon


FNSReferenceGetFamilyInfo

Header: FontSync.h Carbon status: Supported

Obtains information about a font family represented by a font reference.

OSStatus FNSReferenceGetFamilyInfo (
    FNSFontReference iReference, 
    Str255 oFamilyName, 
    ScriptCode *oFamilyNameScript, 
    FMFontStyle *oActualStyle
);
Parameter descriptions
iReference

A reference to the font reference representing a font family.

oFamilyName

On return, the name by which the font is known to the classic Font Manager (that is, the string you pass to the Font Manager function GetFNum).

oFamilyNameScript

On return, a pointer to the script code of the family name string.

oActualStyle

On return, a pointer to the actual QuickDraw style associated with the font reference. This is the value passed back in the oActualStyle parameter of the function FNSReferenceCreateFromFamily. For more information, see the discussion of FNSReferenceCreateFromFamily.

function result

A result code. The result code kFNSBadReferenceVersionErr indicates that a font reference has an unsupported version number. This may indicate that the reference is valid, but created by a later version of FontSync, or that the reference is truly invalid. The result code kFNSInvalidReferenceErr indicates that a font reference is invalid. The result code kFNSInsufficientDataErr indicates that the mask constant kFNSMissingDataNoMatch was set and both references being compared are missing the same data. The result code kFNSMismatchErr indicates that no font names were recorded in the reference.

VERSION NOTES

Available beginning with FontSync 1.0.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when Font Sync 1.0 or later is present.


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