Carbon


RegisterIconRefFromIconFamily

Header: Icons.h Carbon status: Supported

Adds an iconFamily-derived IconRef to the Icon Services registry.

OSErr RegisterIconRefFromIconFamily (
    OSType creator, 
    OSType iconType, 
    IconFamilyHandle iconFamily, 
    IconRef *theIconRef
);
creator

The creator code of the desired icon. You can use your application’s creator code, for example. Lower-case creator codes are reserved for the System.

iconType

The type code of the desired icon.

iconFamily

A handle to the iconFamily data structure to register.

theIconRef

On return, a pointer to the desired icon data.

function result

A result code.

DISCUSSION

Consider using the function RegisterIconRefFromIconFile, since the data registered using the RegisterIconRefFromIconFamily function cannot be purged. You are responsible for disposing of the IconRef by using the function ReleaseIconRef.

Calling this function increments the reference count of the IconRef.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when IconServicesLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by IconServicesLib 8.5 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)