Carbon


GetScrapFlavorFlags

Header: Scrap.h Carbon status: Supported

Obtains information about a specified scrap flavor.

OSStatus GetScrapFlavorFlags (
    ScrapRef scrap, 
    ScrapFlavorType flavorType, 
    ScrapFlavorFlags *flavorFlags
);
Parameter descriptions
scrap

A reference to the scrap to check.

flavorType

The flavor type to check for. Some scrap flavor types are described in “Scrap Flavor Type Constants”.

flavorFlags

A pointer to a variable of type ScrapFlavorFlags. On return, contains information about the flavor specified by flavorType.

function result

A result code.

DISCUSSION

The GetScrapFlavorFlags function tells you whether the scrap contains data for a particular flavor and, if it does, provides some information about that flavor. This function never blocks, and is useful for deciding whether to enable the Paste item in your Edit menu, among other things.

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)