Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 5 - Icon Utilities / Icon Utilities Reference

Icon Utilities Routines / Getting Label Information

GetLabel

You can use the GetLabel function to get the color and string used for a given label in the Label menu of the Finder and in the Labels control panel.

FUNCTION GetLabel (labelNumber: Integer; VAR labelColor: RGBColor; 
                   VAR labelString: Str255): OSErr;

labelNumber

An integer from 1 to 7 indicating which label's information is requested.

labelColor

GetLabel returns, in this parameter, the color of the specified label.

labelString

GetLabel returns, in this parameter, the string associated with the specified label.

DESCRIPTION

The GetLabel function returns the color and string used for a specified label in the Label menu of the Finder and in the Labels control panel.

RESULT CODES

noErr	0	No error
paramErr	-50	The labelNumber parameter is greater than 7

SEE ALSO

For information on the RGBColor record, see Inside Macintosh: Imaging with QuickDraw.