Carbon


GetScrapFlavorSize

Header: Scrap.h Carbon status: Supported

Obtains the size of the data for a specified flavor from a specified scrap.

OSStatus GetScrapFlavorSize (
    ScrapRef scrap, 
    ScrapFlavorType flavorType, 
    Size *byteCount
);
Parameter descriptions
scrap

A reference to the scrap to get the flavor data size from.

flavorType

The flavor type to obtain the size for. Some flavor types are described in “Scrap Flavor Type Constants”.

byteCount

A pointer to a size variable. On return, contains the byte count for the data of the specified flavor.

function result

A result code.

DISCUSSION

This function will block until the size of the data is available. This may mean blocking until the data itself is available, since some scrap senders don't know how big a flavor will be until they've made the flavor data. GetScrapFlavorSize is intended as a prelude to allocating memory and calling GetScrapFlavorData.

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)