Carbon


GetFolderTypes

Header: Folders.h Carbon status: Supported

Obtains the folder types contained in the global descriptor list.

OSErr GetFolderTypes (
    UInt32 requestedTypeCount, 
    UInt32 *totalTypeCount, 
    FolderType *theTypes
);
Parameter descriptions
requestedTypeCount

Pass the number of FolderType values that can fit in the buffer pointed to by the theTypes parameter; see “Folder Type Constants”.

totalTypeCount

Pass a pointer to an unsigned 32-bit integer value. On return, the value is set to the total number of FolderType values in the list. The totalTypeCount parameter may produce a value that is larger or smaller than that of the requestedTypeCount parameter. If totalTypeCount is equal to or smaller than the value passed in for requestedTypeCount and the value produced by the theTypes parameter is non-null, then all folder types were returned to the caller.

theTypes

Pass a pointer to an array of FolderType values; see “Folder Type Constants”. On return, the array contains the folder types for the installed descriptors. You can step through the array and call GetFolderDescriptor for each folder type. Pass null if you only want to know the number of descriptors installed in the system’s global list, rather than the actual folder types of those descriptors.

function result

A result code.

VERSION NOTES

This function is supported under Mac OS 8 and later.

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)