Important: The information in this document is obsolete and should not be used for new development.
IconIDToRgnYou can use the
IconIDToRgnfunction to convert, to a region, the icon mask in an icon family. You specify a rectangle as one of the parameters to this function.
IconIDToRgndetermines, from the size of the specified rectangle, which mask from the icon family to convert. Once it has determined which icon mask to convert,
IconIDToRgnuses the specified rectangle as the bounding box of the region.
FUNCTION IconIDToRgn (theRgn: RgnHandle; iconRect: Rect; align: IconAlignmentType; iconID: Integer): OSErr;
IconIDToRgnreturns a handle to the requested region in this parameter. You must allocate memory for the region handle before calling
- The rectangle in which to draw the icon, specified in local coordinates of the current graphics port.
IconIDToRgnuses this rectangle as the bounding box of the region.
IconIDToRgndetermines, from the size of the rectangle specified in this parameter, which icon mask to use from the icon family specified by
- A value that specifies how
IconIDToRgnshould align the mask within the rectangle. See the description of
PlotIconIDon page 5-20 for a list of constants you can use in this parameter.
- The resource ID of the icon for which to create a region.
IconIDToRgnfunction modifies the region referred to by the handle in the
theRgnparameter. The returned region corresponds to the icon's mask (the mask defined by either an
'ics#'resource in an icon family, according to the rectangle and alignment specified in the
noErr 0 No error noMaskFoundErr -1000 No mask found