Important: The information in this document is obsolete and should not be used for new development.
GetLabel
You can use theGetLabel
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
TheGetLabel
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 7SEE ALSO
For information on theRGBColor
record, see Inside Macintosh: Imaging with QuickDraw.