Carbon


FNSProfileClear

Header: FontSync.h Carbon status: Supported

Removes all font references from a profile.

OSStatus FNSProfileClear (
    FNSFontProfile iProfile
);
Parameter descriptions
iProfile

A font profile reference. Pass a reference to the font profile whose references you wish to remove. The profile must be editable (that is, opened with read/write access).

function result

A result code. The result code kFNSBadProfileVersionErr indicates that the 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 the profile does not have a valid structure. The File Manager error permErr indicates that the file is either locked and not editable or opened for read-only access. FNSProfileClear may return other File Manager errors.

DISCUSSION

The FNSProfileClear function clears all font references from a specified profile. Note that this is only true for editable profiles (that is, those opened with read/write access). The file of the font profile remains the same size after this operation.

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)