Returns information about all the pictures, pixel maps, and bitmaps included in a survey.

OSErr RetrievePictInfo (
    PictInfoID thePictInfoID, 
    PictInfo *thePictInfo, 
    SInt16 colorsRequested
);

Parameter descriptions

thePictInfoID

The ID number, returned by the NewPictInfo function, that identifies the survey of pictures, pixel maps, and bitmaps.

thePictInfo

On return, a pointer to the PictInfo structure that holds information about the pictures or images in the survey.

This function also collects information from black-and-white pictures and bitmaps, and is supported in System 7 even by computers running only basic QuickDraw. However, when collecting color information on a computer running only basic QuickDraw, the function returns NULL instead of a handle to a Palette or ColorTable structure.

colorsRequested

From 1 to 256, the number of colors you want returned in the ColorTable or Palette structure included in the PictInfo structure.

function result

A result code.

DISCUSSION

After using the NewPictInfo function to create a new survey, and then using RecordPictInfo to add pictures to your survey and RecordPixMapInfo to add pixel maps and bitmaps to your survey, call RetrievePictInfo.

When you are finished with the information in the PictInfo structure, dispose of the Palette structure by using the DisposePalette function. Dispose of the ColorTable structure with the DisposeCTable function. Dispose of other allocations with the DisposeHandle function. Use the DisposePictInfo function to dispose of the private data structures created by the NewPictInfo function.

SPECIAL CONSIDERATIONS

The RetrievePictInfo 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)