Carbon


FolderDesc

Header: Folders.h

struct FolderDesc {
    Size descSize; 
    FolderType foldType; 
    FolderDescFlags flags; 
    FolderClass foldClass; 
    FolderType foldLocation; 
    OSType badgeSignature; 
    OSType badgeType; 
    UInt32 reserved; 
    StrFileName name;
};
typedef FolderDesc FolderDescPtr;

Field descriptions

descSize

The size (in bytes) of this structure.

foldType

A constant of type FolderType that identifies the kind of target folder. See “Folder Type Constants” for a list of possible folder types.

flags

Flags indicating whether a folder is created during startup, if the folder name is locked, and if the folder created is invisible; see “Folder Descriptor Flag Constants”.

foldClass

The class indicating whether the folder is relative to the parent folder or special; see “Folder Descriptor Class Constants”.

foldLocation

For a relative folder, the foldLocation field specifies the FolderType of the parent folder of the target. For special folders, the location of the folder. See “Folder Descriptor Location Constants”.

badgeSignature

Reserved. Set this field to 0.

badgeType

Reserved. Set this field to 0.

reserved

Reserved. Set this field to 0.

name

A string specifying the name of the desired folder. For relative folders, this will be the exact name of the desired folder. For special folders, the actual target folder may have a different name than the name specified in the folder descriptor. For example, the System Folder is often given a different name, but it can still be located with FindFolder.

The FolderDesc structure can be used to find existing folder descriptors and create new ones; it is supported under Mac OS 8 and later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)