Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

Inside Macintosh: More Macintosh Toolbox /

Chapter 5 - Icon Utilities / Icon Utilities Reference

Icon Utilities Routines / Getting and Setting the Label for an Icon Suite

GetSuiteLabel
You can use the GetSuiteLabel function to get the default label setting associated with an icon suite.
FUNCTION GetSuiteLabel (theSuite: Handle): Integer;
theSuite
A handle to an icon suite.

DESCRIPTION
The GetSuiteLabel function returns, as its function result, the default label setting associated with the specified icon suite. The default label setting is an integer from 1 to 7 that specifies which of the label colors shown in the Finder's Label menu is applied to icons of that suite when your application displays them. GetSuiteLabel returns 0 if the suite doesn't have a label.
You can override the default label setting for a suite by specifying a label in the transform parameter of the PlotIconSuite function.

SEE ALSO
To get information about the color and string for a specific label, you can use the GetLabel function, which is described on page 5-41.