Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 6 - Component Manager / Component Manager Reference

Routines for Applications / Getting Information About Components

GetComponentIconSuite

The GetComponentIconSuite function returns a handle to the component's icon suite (if it provides one).

FUNCTION GetComponentIconSuite (aComponent: Component; 
                                VAR iconSuite: Handle): OSErr;

aComponent

A component identifier that specifies the component for the operation. Your application obtains a component identifier from the FindNextComponent function. If your application registers a component, it can also obtain a component identifier from the RegisterComponent or RegisterComponentResource function.

iconSuite

GetComponentIconSuite returns, in this parameter, a handle to the component's icon suite, if any. If the component has not provided an icon suite, GetComponentIconSuite returns NIL in this parameter.

DESCRIPTION

The GetComponentIconSuite function returns a handle to the component's icon suite. A component provides to the Component Manager the resource ID of its icon family in the optional extensions to the component resource. Your application is responsible for disposing of the returned icon suite handle.

SPECIAL CONSIDERATIONS

The GetComponentIconSuite function is available only in version 3 of the Component Manager.

RESULT CODES

noErr	0	No error
invalidComponentID	-3000	No component with this component identifier

SEE ALSO

For information about icon suites and icon families, see the chapter "Icon Utilities" in this book.