Carbon


FNSReferenceUnflatten

Header: FontSync.h Carbon status: Supported

Reconstitutes a flattened font reference.

OSStatus FNSReferenceUnflatten (
    const void *iFlatReference, 
    ByteCount iFlattenedSize, 
    FNSFontReference *oReference
);
Parameter descriptions
iFlatReference

A pointer to the flattened font reference.

iFlattenedSize

The size (in bytes) of the flattened font reference.

oReference

On return, a pointer to a reference to the reconstituted font reference.

function result

A result code. The result code kFNSBadReferenceVersionErr indicates that a font reference has an unsupported format version. 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 kFNSBadFlattenedSizeErr indicates that either the specified size doesn’t match the size recorded in the flattened reference or the size was not large enough to hold a flattened reference. The result code kFNSInvalidReferenceErr indicates that a reconstructed reference is bad. Memory Manager errors indicate that you did not have enough memory available in your heap.

DISCUSSION

The FNSReferenceUnflatten function reconstitutes a flattened font reference from its external form. For example, you could use FNSReferenceUnflatten to read a font reference out of a document. The iFlattenedSize parameter is not really necessary since a flattened reference contains its own size. However, you can use this value to check that you have passed the right amount of data for the flattened 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)