Carbon


RecordPictInfo

Header: PictUtils.h Carbon status: Supported

Adds a picture to an informational survey of multiple pictures.

OSErr RecordPictInfo (
    PictInfoID thePictInfoID, 
    PicHandle thePictHandle
);
Parameter descriptions
thePictInfoID

The ID number—returned by the NewPictInfo function—that identifies the survey to which you are adding the picture.

thePictHandle

A handle to the picture being added to the survey.

function result

A result code.

DISCUSSION

The RecordPictInfo function adds the picture you specify in the parameter thePictHandle to the survey of pictures identified by the parameter thePictInfoID. Use RecordPictInfo repeatedly to add additional pictures to your survey.

After you have collected all of the pictures you need, use the RetrievePictInfo function to return information about pictures in the survey.

SPECIAL CONSIDERATIONS

When you ask for color information, RecordPictInfo takes into account only the version 2 and extended version picture opcodes RGBFgCol, RGBBkCol, BkPixPat, PnPixPat, FillPixPat, and HiliteColor. Each occurrence of these opcodes is treated as 1 pixel, regardless of the number and sizes of the objects drawn with that color. If you need an accurate set of colors from a complex picture, create an image of the picture in an offscreen pixel map, and then call the GetPixMapInfo function to obtain color information about that pixel map.

The RecordPictInfo function may move or purge memory.

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 6/30/2000)