Carbon


GetFolderDescriptor

Header: Folders.h Carbon status: Supported

Obtains the folder descriptor information for the specified folder type from the global descriptor list.

OSErr GetFolderDescriptor (
    FolderType foldType, 
    Size descSize, 
    FolderDesc *foldDesc
);
Parameter descriptions
foldType

Pass a constant identifying the type of the folder for which you wish to get descriptor information. See “Folder Type Constants”.

descSize

Pass the size (in bytes) of the folder descriptor structure for which a pointer is passed in the foldDesc parameter. This value is needed in order to determine the version of the structure being used.

foldDesc

Pass a pointer to a folder descriptor structure. On return, the folder descriptor structure contains information from the global descriptor list for the specified folder type.

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)