Carbon


FNSProfileRemoveReference

Header: FontSync.h Carbon status: Supported

Deletes a font reference from a profile.

OSStatus FNSProfileRemoveReference (
    FNSFontProfile iProfile, 
    FNSFontReference iReference
);
Parameter descriptions
iProfile

A reference to the font profile whose font reference you want to delete. The profile must be writable.

iReference

A reference to the font reference you wish to remove.

function result

A result code. The result code kFNSBadProfileVersionErr indicates that a font profile has an unsupported format version. This may indicate that the profile is valid, but created by a later version of FontSync, or that the profile is truly invalid. The result code kFNSInvalidProfileErr indicates that a profile does not have a valid structure. 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 kFNSInvalidReferenceErr indicates that a font reference is invalid. The result code kFNSMismatchErr indicates that the reference you wish to remove is not in the profile. The File Manager error permErr indicates that the file is either locked and not editable or opened for read-only access. FNSProfileRemoveReference may return other File Manager errors. Memory Manager errors indicate that you did not have enough memory available in your heap.

DISCUSSION

The FNSProfileRemoveReference function deletes a font reference from an editable profile. The reference must be identical to the reference specified in the iReference parameter. A matching reference is not necessarily identical, since not all the data in a font reference is examined when a matching operation is performed.

You can use either FNSProfileRemoveReference or the function FNSProfileRemoveIndReference to remove a font reference, depending upon what you know about the reference. If you know the value of the reference, call FNSProfileRemoveReference. If you know its index in the list of font references, call FNSProfileRemoveIndReference.

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)