![]() |
GetScrapFlavorData |
||||
Header: | Scrap.h | Carbon status: | Supported | |
Obtains the data for the specified flavor from the specified scrap.
OSStatus GetScrapFlavorData ( ScrapRef scrap, ScrapFlavorType flavorType, Size *byteCount, void *destination );
A reference to the scrap to get data from.
The flavor type to obtain data for. Some flavor types are described in
A pointer to a size variable. Before calling GetScrapFlavorData, specify the maximum number of bytes your buffer can contain. On return, provides the number of bytes that were available (even if this is more than you requested).
A pointer to a buffer, local variable, or other storage location created and disposed of by your application. The size in bytes must be at least as large as the value you pass in the byteCount parameter. On return, contains the specified flavor data. The amount of data returned will not exceed the value you passed in byteCount, even if the number of bytes available is more than you specified in byteCount.
A result code.
This function blocks until the specified flavor data is available.
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)