Important: The information in this document is obsolete and should not be used for new development.
IconSuiteToRgnYou can use the
IconSuiteToRgnfunction to convert, to a region, the icon mask in an icon suite. You specify a rectangle as one of the parameters to this function.
IconSuiteToRgndetermines, from the size of the specified rectangle, which mask from the icon suite to convert. Once it has determined which icon mask to convert,
IconSuiteToRgnuses the specified rectangle as the bounding box of the region.
FUNCTION IconSuiteToRgn (theRgn: RgnHandle; iconRect: Rect; align: IconAlignmentType; theIconSuite: Handle): OSErr;
IconSuiteToRgnreturns a handle to the requested region in this parameter. You must allocate memory for the region handle before calling
- The rectangle in which the icon is to be drawn, specified in local coordinates of the current graphics port.
IconSuiteToRgnuses this rectangle as the bounding box of the region.
IconSuiteToRgndetermines, from the size of the rectangle specified in this parameter, which icon mask to use from the icon suite.
- A value that specifies how
IconSuiteToRgnshould align the region within the rectangle. See the description of
PlotIconSuiteon page 5-35 for a list of constants you can use in this parameter.
- A handle to an icon suite.
IconSuiteToRgnfunction 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#'entry in an icon suite, according to the rectangle and alignment specified in the
noErr 0 No error noMaskFoundErr -1000 No mask found