PBDTGetIconInfoSync

PBDTGetIconInfoSync
Header:	Files.h		Carbon status:	Supported

Retrieves an icon type and the associated file type supported by a given creator in the database. You use it to identify the set of icons associated with each file type that is supported by a given creator. This function runs synchronously.

OSErr PBDTGetIconInfoSync (
    DTPBPtr paramBlock
);

Parameter descriptions

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioCompletionOn input, a universal procedure pointer to a completion function. A value of type IOCompletionUPP.
ioResultOn return, the result code of the function. A value of type OSErr.
ioDTRefNumOn input, the desktop database reference number. A value of type SInt16.
ioIndexOn input, an index into the icon list. A value of type SInt16.
ioTagInfoOn input, reserved; must be set to 0. A value of type SInt32.
ioDTActCountOn return, the size of the icon’s bitmap. A value of type SInt32.
ioIconTypeOn return, the icon type, including the icon size and color depth. A value of type SInt8. For a description of the values you can use in this field, see “Icon Type Constants”. Ignore any values returned in ioIconType that are not listed there; they represent special icons and information used only by the Finder.
ioFileCreatorOn input, the icon’s file creator. A value of type OSType.
ioFileTypeOn return, the icon’s file type. A value of type OSType.

You specify the creator by placing its signature in ioFileCreator, and you specify the database by placing the desktop database reference number in the ioDTRefNum field.

To step through a list of the icon types and file types supported by an application, make repeated calls to PBDTGetIconInfo, specifying a creator and an index value for ioIndex each call. Set the index to 1 on the first call, and increment it on each subsequent call until ioResult returns afpItemNotFound.

To get a list of file types that an application can natively open, you can use the Translation Manager function, GetFileTypesThatAppCanNativelyOpen.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.