Carbon


GetScrapFlavorInfoList

Header: Scrap.h Carbon status: Supported

Fills a list (array) with items which each describe a corresponding flavor in the scrap.

OSStatus GetScrapFlavorInfoList (
    ScrapRef scrap, 
    UInt32 *infoCount, 
    ScrapFlavorInfo info[]
);
Parameter descriptions
scrap

A reference to the scrap to get the flavor information for.

infoCount

A pointer to a count variable. Before calling GetScrapFlavorInfoList, set the value to the number of flavors to get information for. Your application typically obtains the flavor count by calling GetScrapFlavorCount.

On return, specifies the number of flavors for which information was supplied, which may be smaller than the number requested.

info

An array of type ScrapFlavorInfo, whose size is indicated by the infoCount parameter, and that is created and disposed of by your application. On return, the array elements contain the flavor information.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)