Folders.h File Reference

Folder Manager Interfaces. More...

#include <MacTypes.h>
#include <MixedMode.h>
#include <Files.h>

Go to the source code of this file.

Data Structures
struct	FolderDesc
struct	FolderRouting
struct	FindFolderUserRedirectionGlobals
struct	MultiUserGestalt

Macros
#define	NewFolderManagerNotificationUPP(userRoutine)
#define	DisposeFolderManagerNotificationUPP(userUPP)    DisposeRoutineDescriptor(userUPP)
#define	InvokeFolderManagerNotificationUPP(message, arg, userRefCon, userUPP)
#define	NewFolderManagerNotificationProc(userRoutine)    NewFolderManagerNotificationUPP(userRoutine)
#define	CallFolderManagerNotificationProc(userRoutine, message, arg, userRefCon)    InvokeFolderManagerNotificationUPP(message, arg, userRefCon, userRoutine)

Typedefs
typedef UInt32	FolderDescFlags
typedef OSType	FolderClass
typedef OSType	FolderType
typedef OSType	FolderLocation
typedef struct FolderDesc	FolderDesc
typedef FolderDesc *	FolderDescPtr
typedef UInt32	RoutingFlags
typedef struct FolderRouting	FolderRouting
typedef FolderRouting *	FolderRoutingPtr
typedef struct FindFolderUserRedirectionGlobals	FindFolderUserRedirectionGlobals
typedef FindFolderUserRedirectionGlobals *	FindFolderUserRedirectionGlobalsPtr
typedef void *	arg
typedef void void *	userRefCon
typedef struct MultiUserGestalt	MultiUserGestalt
typedef MultiUserGestalt *	MultiUserGestaltPtr
typedef MultiUserGestaltPtr *	MultiUserGestaltHandle

Enumerations
enum	{   kOnSystemDisk = -32768L , kOnAppropriateDisk , kSystemDomain = -32766 , kLocalDomain = -32765 ,   kNetworkDomain = -32764 , kUserDomain , kClassicDomain = -32762 }
enum	{ kCreateFolder = true , kDontCreateFolder = false }
enum	{   kSystemFolderType = FOUR_CHAR_CODE('macs') , kDesktopFolderType , kSystemDesktopFolderType , kTrashFolderType ,   kSystemTrashFolderType , kWhereToEmptyTrashFolderType , kPrintMonitorDocsFolderType , kStartupFolderType ,   kShutdownFolderType , kAppleMenuFolderType , kControlPanelFolderType , kSystemControlPanelFolderType ,   kExtensionFolderType , kFontsFolderType = FOUR_CHAR_CODE('font') , kPreferencesFolderType , kSystemPreferencesFolderType ,   kTemporaryFolderType }
enum	{   kExtensionDisabledFolderType = FOUR_CHAR_CODE('extD') , kControlPanelDisabledFolderType = FOUR_CHAR_CODE('ctrD') , kSystemExtensionDisabledFolderType = FOUR_CHAR_CODE('macD') , kStartupItemsDisabledFolderType = FOUR_CHAR_CODE('strD') ,   kShutdownItemsDisabledFolderType = FOUR_CHAR_CODE('shdD') , kApplicationsFolderType = FOUR_CHAR_CODE('apps') , kDocumentsFolderType = FOUR_CHAR_CODE('docs') }
enum	{   kVolumeRootFolderType = FOUR_CHAR_CODE('root') , kChewableItemsFolderType , kApplicationSupportFolderType , kTextEncodingsFolderType = FOUR_CHAR_CODE('©tex') ,   kStationeryFolderType = FOUR_CHAR_CODE('odst') , kOpenDocFolderType = FOUR_CHAR_CODE('odod') , kOpenDocShellPlugInsFolderType , kEditorsFolderType ,   kOpenDocEditorsFolderType , kOpenDocLibrariesFolderType , kGenEditorsFolderType , kHelpFolderType ,   kInternetPlugInFolderType , kModemScriptsFolderType , kPrinterDescriptionFolderType , kPrinterDriverFolderType ,   kScriptingAdditionsFolderType , kSharedLibrariesFolderType , kVoicesFolderType = FOUR_CHAR_CODE('fvoc') , kControlStripModulesFolderType ,   kAssistantsFolderType , kUtilitiesFolderType = FOUR_CHAR_CODE('uti©') , kAppleExtrasFolderType , kContextualMenuItemsFolderType ,   kMacOSReadMesFolderType , kALMModulesFolderType , kALMPreferencesFolderType , kALMLocationsFolderType ,   kColorSyncProfilesFolderType , kThemesFolderType = FOUR_CHAR_CODE('thme') , kFavoritesFolderType , kInternetFolderType ,   kAppearanceFolderType , kSoundSetsFolderType , kDesktopPicturesFolderType , kInternetSearchSitesFolderType ,   kFindSupportFolderType = FOUR_CHAR_CODE('fnds') , kFindByContentFolderType , kInstallerLogsFolderType , kScriptsFolderType = FOUR_CHAR_CODE('scr©') ,   kFolderActionsFolderType , kLauncherItemsFolderType , kRecentApplicationsFolderType , kRecentDocumentsFolderType ,   kRecentServersFolderType , kSpeakableItemsFolderType , kKeychainFolderType = FOUR_CHAR_CODE('kchn') , kQuickTimeExtensionsFolderType ,   kDisplayExtensionsFolderType , kMultiprocessingFolderType , kPrintingPlugInsFolderType }
enum	{   kDomainTopLevelFolderType , kDomainLibraryFolderType , kColorSyncFolderType , kColorSyncCMMFolderType = FOUR_CHAR_CODE('ccmm') ,   kColorSyncScriptingFolderType , kPrintersFolderType , kSpeechFolderType , kCarbonLibraryFolderType ,   kDocumentationFolderType , kDeveloperDocsFolderType , kDeveloperHelpFolderType , kISSDownloadsFolderType ,   kUserSpecificTmpFolderType , kCachedDataFolderType , kFrameworksFolderType , kPrivateFrameworksFolderType ,   kClassicDesktopFolderType , kDeveloperFolderType , kSystemSoundsFolderType , kComponentsFolderType ,   kQuickTimeComponentsFolderType , kCoreServicesFolderType , kPictureDocumentsFolderType , kMovieDocumentsFolderType ,   kMusicDocumentsFolderType , kInternetSitesFolderType , kPublicFolderType , kAudioSupportFolderType ,   kAudioSoundsFolderType , kAudioSoundBanksFolderType , kAudioAlertSoundsFolderType , kAudioPlugInsFolderType ,   kAudioComponentsFolderType , kKernelExtensionsFolderType , kDirectoryServicesFolderType , kDirectoryServicesPlugInsFolderType ,   kInstallerReceiptsFolderType , kFileSystemSupportFolderType , kAppleShareSupportFolderType , kAppleShareAuthenticationFolderType ,   kMIDIDriversFolderType }
enum	{ kLocalesFolderType = FOUR_CHAR_CODE('©loc') , kFindByContentPluginsFolderType }
enum	{   kUsersFolderType , kCurrentUserFolderType , kCurrentUserRemoteFolderLocation , kCurrentUserRemoteFolderType ,   kSharedUserDataFolderType , kVolumeSettingsFolderType }
enum	{   kAppleshareAutomountServerAliasesFolderType , kPreMacOS91ApplicationsFolderType , kPreMacOS91InstallerLogsFolderType , kPreMacOS91AssistantsFolderType ,   kPreMacOS91UtilitiesFolderType , kPreMacOS91AppleExtrasFolderType , kPreMacOS91MacOSReadMesFolderType , kPreMacOS91InternetFolderType ,   kPreMacOS91AutomountedServersFolderType , kPreMacOS91StationeryFolderType }
enum	{   kCreateFolderAtBoot = 0x00000002 , kCreateFolderAtBootBit = 1 , kFolderCreatedInvisible = 0x00000004 , kFolderCreatedInvisibleBit = 2 ,   kFolderCreatedNameLocked = 0x00000008 , kFolderCreatedNameLockedBit = 3 , kFolderCreatedAdminPrivs = 0x00000010 , kFolderCreatedAdminPrivsBit = 4 }
enum	{   kFolderInUserFolder = 0x00000020 , kFolderInUserFolderBit = 5 , kFolderTrackedByAlias = 0x00000040 , kFolderTrackedByAliasBit = 6 ,   kFolderInRemoteUserFolderIfAvailable = 0x00000080 , kFolderInRemoteUserFolderIfAvailableBit = 7 , kFolderNeverMatchedInIdentifyFolder = 0x00000100 , kFolderNeverMatchedInIdentifyFolderBit = 8 ,   kFolderMustStayOnSameVolume = 0x00000200 , kFolderMustStayOnSameVolumeBit = 9 , kFolderManagerFolderInMacOS9FolderIfMacOSXIsInstalledMask = 0x00000400 , kFolderManagerFolderInMacOS9FolderIfMacOSXIsInstalledBit = 10 ,   kFolderInLocalOrRemoteUserFolder }
enum	{ kRelativeFolder = FOUR_CHAR_CODE('relf') , kSpecialFolder = FOUR_CHAR_CODE('spcf') }
enum	{ kBlessedFolder = FOUR_CHAR_CODE('blsf') , kRootFolder = FOUR_CHAR_CODE('rotf') }
enum	{ kCurrentUserFolderLocation }
enum	{ kFindFolderRedirectionFlagUseDistinctUserFoldersBit , kFindFolderRedirectionFlagUseGivenVRefAndDirIDAsUserFolderBit , kFindFolderRedirectionFlagsUseGivenVRefNumAndDirIDAsRemoteUserFolderBit = 2 }
enum	{ kFolderManagerUserRedirectionGlobalsCurrentVersion = 1 }
enum	{ kFindFolderExtendedFlagsDoNotFollowAliasesBit = 0 , kFindFolderExtendedFlagsDoNotUseUserFolderBit = 1 , kFindFolderExtendedFlagsUseOtherUserRecord = 0x01000000 }
enum	{ uppFolderManagerNotificationProcInfo = 0x00000FF0 }
enum	{   kFolderManagerNotificationMessageUserLogIn , kFolderManagerNotificationMessagePreUserLogIn , kFolderManagerNotificationMessageUserLogOut , kFolderManagerNotificationMessagePostUserLogOut ,   kFolderManagerNotificationDiscardCachedData , kFolderManagerNotificationMessageLoginStartup }
enum	{ kDoNotRemoveWhenCurrentApplicationQuitsBit = 0 , kDoNotRemoveWheCurrentApplicationQuitsBit }
enum	{ kStopIfAnyNotificationProcReturnsErrorBit = 31 }

Functions
OSErr	FindFolder (short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
OSErr	FindFolderExtended (short vol, OSType foldType, Boolean createFolder, UInt32 flags, void *data, short *vRefNum, long *dirID)
OSErr	ReleaseFolder (short vRefNum, OSType folderType)
OSErr	FindFolderEx (short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID, char *foundFolder)
OSErr	FSFindFolder (short vRefNum, OSType folderType, Boolean createFolder, FSRef *foundRef)
OSErr	FSFindFolderExtended (short vol, OSType foldType, Boolean createFolder, UInt32 flags, void *data, FSRef *foundRef)
typedef	CALLBACK_API (OSStatus, FolderManagerNotificationProcPtr)(OSType message
typedef	STACK_UPP_TYPE (FolderManagerNotificationProcPtr) FolderManagerNotificationUPP
FolderManagerNotificationUPP	NewFolderManagerNotificationUPP (FolderManagerNotificationProcPtr userRoutine)
void	DisposeFolderManagerNotificationUPP (FolderManagerNotificationUPP userUPP)
OSStatus	InvokeFolderManagerNotificationUPP (OSType message, void *arg, void *userRefCon, FolderManagerNotificationUPP userUPP)
OSErr	AddFolderDescriptor (FolderType foldType, FolderDescFlags flags, FolderClass foldClass, FolderLocation foldLocation, OSType badgeSignature, OSType badgeType, ConstStrFileNameParam name, Boolean replaceFlag)
OSErr	GetFolderDescriptor (FolderType foldType, Size descSize, FolderDesc *foldDesc)
OSErr	GetFolderTypes (UInt32 requestedTypeCount, UInt32 *totalTypeCount, FolderType *theTypes)
OSErr	RemoveFolderDescriptor (FolderType foldType)
OSErr	GetFolderName (short vRefNum, OSType foldType, short *foundVRefNum, StrFileName name)
OSErr	AddFolderRouting (OSType fileType, FolderType routeFromFolder, FolderType routeToFolder, RoutingFlags flags, Boolean replaceFlag)
OSErr	RemoveFolderRouting (OSType fileType, FolderType routeFromFolder)
OSErr	FindFolderRouting (OSType fileType, FolderType routeFromFolder, FolderType *routeToFolder, RoutingFlags *flags)
OSErr	GetFolderRoutings (UInt32 requestedRoutingCount, UInt32 *totalRoutingCount, Size routingSize, FolderRouting *theRoutings)
OSErr	InvalidateFolderDescriptorCache (short vRefNum, long dirID)
OSErr	IdentifyFolder (short vRefNum, long dirID, FolderType *foldType)
OSErr	FolderManagerRegisterNotificationProc (FolderManagerNotificationUPP notificationProc, void *refCon, UInt32 options)
OSErr	FolderManagerUnregisterNotificationProc (FolderManagerNotificationUPP notificationProc, void *refCon)
OSStatus	FolderManagerRegisterCallNotificationProcs (OSType message, void *arg, UInt32 options)

Detailed Description

Folder Manager Interfaces.

Introduced In: Mac OS 8

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1995-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

InvokeFolderManagerNotificationUPP

#define InvokeFolderManagerNotificationUPP	(		message,
			arg,
			userRefCon,
			userUPP
	)

Value:

    (OSStatus) CALL_THREE_PARAMETER_UPP((userUPP),                            \
                                        uppFolderManagerNotificationProcInfo, \
                                        (message), (arg), (userRefCon))

NewFolderManagerNotificationProc

#define NewFolderManagerNotificationProc

(

userRoutine

)

NewFolderManagerNotificationUPP(userRoutine)

support for pre-Carbon UPP routines: New...Proc and Call...Proc

NewFolderManagerNotificationUPP

#define NewFolderManagerNotificationUPP

(

userRoutine

)

Value:

    (FolderManagerNotificationUPP) NewRoutineDescriptor(              \
        (ProcPtr)(userRoutine), uppFolderManagerNotificationProcInfo, \
        GetCurrentArchitecture())

pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes)

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kOnAppropriateDisk	previously was 0x8000 but that is an unsigned value whereas vRefNum is signed
kSystemDomain	Generally, the same as kOnSystemDisk, but it's clearer that this isn't always the 'boot' disk. Folder Domains - Carbon only. The constants above can continue to be used, but the folder/volume returned will be from one of the domains below.
kLocalDomain	Read-only system hierarchy.
kNetworkDomain	All users of a single machine have access to these resources.
kUserDomain	All users configured to use a common network server has access to these resources.
kClassicDomain	Read/write. Resources that are private to the user.

anonymous enum

anonymous enum

Enumerator
kDesktopFolderType	the system folder
kSystemDesktopFolderType	the desktop folder; objects in this folder show on the desk top.
kTrashFolderType	the desktop folder at the root of the hard drive, never the redirected user desktop folder
kSystemTrashFolderType	the trash folder; objects in this folder show up in the trash
kWhereToEmptyTrashFolderType	the trash folder at the root of the drive, never the redirected user trash folder
kPrintMonitorDocsFolderType	the "empty trash" folder; Finder starts empty from here down
kStartupFolderType	Print Monitor documents
kShutdownFolderType	Finder objects (applications, documents, DAs, aliases, to...) to open at startup go here
kAppleMenuFolderType	Finder objects (applications, documents, DAs, aliases, to...) to open at shutdown go here
kControlPanelFolderType	Finder objects to put into the Apple menu go here
kSystemControlPanelFolderType	Control Panels go here (may contain INITs)
kExtensionFolderType	System control panels folder - never the redirected one, always "Control Panels" inside the System Folder
kFontsFolderType	System extensions go here
kPreferencesFolderType	Fonts go here
kSystemPreferencesFolderType	preferences for applications go here
kTemporaryFolderType	System-type Preferences go here - this is always the system's preferences folder, never a logged in user's

anonymous enum

anonymous enum

Extensible Folder Manager declarations Folder Manager constants

anonymous enum

anonymous enum

Enumerator
kVolumeRootFolderType	new constants
kChewableItemsFolderType	root folder of a volume
kApplicationSupportFolderType	items deleted at boot
kTextEncodingsFolderType	third-party items and folders
kStationeryFolderType	encoding tables
kOpenDocFolderType	stationery
kOpenDocShellPlugInsFolderType	OpenDoc root
kEditorsFolderType	OpenDoc Shell Plug-Ins in OpenDoc folder
kOpenDocEditorsFolderType	OpenDoc editors in MacOS Folder
kOpenDocLibrariesFolderType	OpenDoc subfolder of Editors folder
kGenEditorsFolderType	OpenDoc libraries folder
kHelpFolderType	CKH general editors folder at root level of Sys folder
kInternetPlugInFolderType	CKH help folder currently at root of system folder
kModemScriptsFolderType	CKH internet plug ins for browsers and stuff
kPrinterDescriptionFolderType	CKH modem scripts, get 'em OUT of the Extensions folder
kPrinterDriverFolderType	CKH new folder at root of System folder for printer descs.
kScriptingAdditionsFolderType	CKH new folder at root of System folder for printer drivers
kSharedLibrariesFolderType	CKH at root of system folder
kVoicesFolderType	CKH for general shared libs.
kControlStripModulesFolderType	CKH macintalk can live here
kAssistantsFolderType	CKH for control strip modules
kUtilitiesFolderType	SJF for Assistants (MacOS Setup Assistant, etc)
kAppleExtrasFolderType	SJF for Utilities folder
kContextualMenuItemsFolderType	SJF for Apple Extras folder
kMacOSReadMesFolderType	SJF for Contextual Menu items
kALMModulesFolderType	SJF for MacOS ReadMes folder
kALMPreferencesFolderType	EAS for Location Manager Module files except type 'thng' (within kExtensionFolderType)
kALMLocationsFolderType	EAS for Location Manager Preferences (within kPreferencesFolderType; contains kALMLocationsFolderType)
kColorSyncProfilesFolderType	EAS for Location Manager Locations (within kALMPreferencesFolderType)
kThemesFolderType	for ColorSync© Profiles
kFavoritesFolderType	for Theme data files
kInternetFolderType	Favorties folder for Navigation Services
kAppearanceFolderType	Internet folder (root level of startup volume)
kSoundSetsFolderType	Appearance folder (root of system folder)
kDesktopPicturesFolderType	Sound Sets folder (in Appearance folder)
kInternetSearchSitesFolderType	Desktop Pictures folder (in Appearance folder)
kFindSupportFolderType	Internet Search Sites folder
kFindByContentFolderType	Find support folder
kInstallerLogsFolderType	Find by content folder
kScriptsFolderType	Installer Logs folder
kFolderActionsFolderType	Scripts folder
kLauncherItemsFolderType	Folder Actions Scripts folder
kRecentApplicationsFolderType	Launcher Items folder
kRecentDocumentsFolderType	Recent Applications folder
kRecentServersFolderType	Recent Documents folder
kSpeakableItemsFolderType	Recent Servers folder
kKeychainFolderType	Speakable Items folder
kQuickTimeExtensionsFolderType	Keychain folder
kDisplayExtensionsFolderType	QuickTime Extensions Folder (in Extensions folder)
kMultiprocessingFolderType	Display Extensions Folder (in Extensions folder)
kPrintingPlugInsFolderType	Multiprocessing Folder (in Extensions folder)

anonymous enum

anonymous enum

New Folder Types to accommodate the Mac OS X Folder Manager These folder types are not applicable on Mac OS 9.

Enumerator
kDomainLibraryFolderType	The top-level of a Folder domain, e.g. "/System"
kColorSyncFolderType	the Library subfolder of a particular domain
kColorSyncCMMFolderType	Contains ColorSync-related folders
kColorSyncScriptingFolderType	ColorSync CMMs
kPrintersFolderType	ColorSync Scripting support
kSpeechFolderType	Contains Printing-related folders
kCarbonLibraryFolderType	Contains Speech-related folders
kDocumentationFolderType	Contains Carbon-specific file
kDeveloperDocsFolderType	Contains Documentation files (not user documents)
kDeveloperHelpFolderType	Contains Developer Documentation files and folders
kISSDownloadsFolderType	Contains Developer Help related files
kUserSpecificTmpFolderType	Contains Internet Search Sites downloaded from the Internet
kCachedDataFolderType	Contains temporary items created on behalf of the current user
kFrameworksFolderType	Contains various cache files for different clients
kPrivateFrameworksFolderType	Contains MacOS X Framework folders
kClassicDesktopFolderType	Contains MacOS X Private Framework folders
kDeveloperFolderType	MacOS 9 compatible desktop folder - same as kSystemDesktopFolderType but with a more appropriate name for Mac OS X code.
kSystemSoundsFolderType	Contains MacOS X Developer Resources
kComponentsFolderType	Contains Mac OS X System Sound Files
kQuickTimeComponentsFolderType	Contains Mac OS X components
kCoreServicesFolderType	Contains QuickTime components for Mac OS X
kPictureDocumentsFolderType	Refers to the "CoreServices" folder on Mac OS X
kMovieDocumentsFolderType	Refers to the "Pictures" folder in a users home directory
kMusicDocumentsFolderType	Refers to the "Movies" folder in a users home directory
kInternetSitesFolderType	Refers to the "Music" folder in a users home directory
kPublicFolderType	Refers to the "Sites" folder in a users home directory
kAudioSupportFolderType	Refers to the "Public" folder in a users home directory
kAudioSoundsFolderType	Refers to the Audio support folder for Mac OS X
kAudioSoundBanksFolderType	Refers to the Sounds subfolder of Audio Support
kAudioAlertSoundsFolderType	Refers to the Banks subfolder of the Sounds Folder
kAudioPlugInsFolderType	Refers to the Alert Sounds subfolder of the Sound Folder
kAudioComponentsFolderType	Refers to the Plug-ins subfolder of the Audio Folder
kKernelExtensionsFolderType	Refers to the Components subfolder of the Audio Plug-ins Folder
kDirectoryServicesFolderType	Refers to the Kernel Extensions Folder on Mac OS X
kDirectoryServicesPlugInsFolderType	Refers to the Directory Services folder on Mac OS X
kInstallerReceiptsFolderType	Refers to the Directory Services Plug-Ins folder on Mac OS X
kFileSystemSupportFolderType	Refers to the "Receipts" folder in Mac OS X
kAppleShareSupportFolderType	Refers to the [domain]/Library/Filesystems folder in Mac OS X
kAppleShareAuthenticationFolderType	Refers to the [domain]/Library/Filesystems/AppleShare folder in Mac OS X
kMIDIDriversFolderType	Refers to the [domain]/Library/Filesystems/AppleShare/Authentication folder in Mac OS X

anonymous enum

anonymous enum

Enumerator
kFindByContentPluginsFolderType	PKE for Locales folder

anonymous enum

anonymous enum

Enumerator
kCurrentUserFolderType	"Users" folder, contains one folder for each user.
kCurrentUserRemoteFolderLocation	The folder for the currently logged on user.
kCurrentUserRemoteFolderType	The remote folder for the currently logged on user
kSharedUserDataFolderType	The remote folder location for the currently logged on user
kVolumeSettingsFolderType	A Shared "Documents" folder, readable & writeable by all users

anonymous enum

anonymous enum

Enumerator
kPreMacOS91ApplicationsFolderType	Appleshare puts volumes to automount inside this folder.
kPreMacOS91InstallerLogsFolderType	The "Applications" folder, pre Mac OS 9.1
kPreMacOS91AssistantsFolderType	The "Installer Logs" folder, pre Mac OS 9.1
kPreMacOS91UtilitiesFolderType	The "Assistants" folder, pre Mac OS 9.1
kPreMacOS91AppleExtrasFolderType	The "Utilities" folder, pre Mac OS 9.1
kPreMacOS91MacOSReadMesFolderType	The "Apple Extras" folder, pre Mac OS 9.1
kPreMacOS91InternetFolderType	The "Mac OS ReadMes" folder, pre Mac OS 9.1
kPreMacOS91AutomountedServersFolderType	The "Internet" folder, pre Mac OS 9.1
kPreMacOS91StationeryFolderType	The "Servers" folder, pre Mac OS 9.1

anonymous enum

anonymous enum

FolderDescFlags values

anonymous enum

anonymous enum

FolderClass values

anonymous enum

anonymous enum

special folder locations

anonymous enum

anonymous enum

routing constants These are bits in the .flags field of the FindFolderUserRedirectionGlobals struct

Enumerator
kFindFolderRedirectionFlagUseDistinctUserFoldersBit	Set this bit to 1 in the .flags field of a FindFolderUserRedirectionGlobals structure if the userName in the struct should be used as the current "User" name
kFindFolderRedirectionFlagUseGivenVRefAndDirIDAsUserFolderBit	Set this bit to 1 and the currentUserFolderVRefNum and currentUserFolderDirID fields of the user record will get used instead of finding the user folder with the userName field.
kFindFolderRedirectionFlagsUseGivenVRefNumAndDirIDAsRemoteUserFolderBit	Set this bit to 1 and the remoteUserFolderVRefNum and remoteUserFolderDirID fields of the user record will get used instead of finding the user folder with the userName field.

anonymous enum

anonymous enum

These are passed into FindFolderExtended(), FindFolderInternalExtended(), and FindFolderNewInstallerEntryExtended() in the flags field.

anonymous enum

anonymous enum

CALL_NOT_IN_CARBON

Enumerator
kFolderManagerNotificationMessagePreUserLogIn	Sent by system & third party software after a user logs in. arg should point to a valid FindFolderUserRedirectionGlobals structure or nil for the owner
kFolderManagerNotificationMessageUserLogOut	Sent by system & third party software before a user logs in. arg should point to a valid FindFolderUserRedirectionGlobals structure or nil for the owner
kFolderManagerNotificationMessagePostUserLogOut	Sent by system & third party software before a user logs out. arg should point to a valid FindFolderUserRedirectionGlobals structure or nil for the owner
kFolderManagerNotificationDiscardCachedData	Sent by system & third party software after a user logs out. arg should point to a valid FindFolderUserRedirectionGlobals structure or nil for the owner
kFolderManagerNotificationMessageLoginStartup	Sent by system & third party software when the entire Folder Manager cache should be flushed

anonymous enum

anonymous enum

These get used in the options parameter of FolderManagerRegisterNotificationProc()

anonymous enum

anonymous enum

These get used in the options parameter of FolderManagerCallNotificationProcs()

Function Documentation

AddFolderDescriptor()

OSErr AddFolderDescriptor	(	FolderType	foldType,
		FolderDescFlags	flags,
		FolderClass	foldClass,
		FolderLocation	foldLocation,
		OSType	badgeSignature,
		OSType	badgeType,
		ConstStrFileNameParam	name,
		Boolean	replaceFlag
	)

Folder Manager routines Folder Manager administration routines AddFolderDescriptor()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AddFolderRouting()

OSErr AddFolderRouting	(	OSType	fileType,
		FolderType	routeFromFolder,
		FolderType	routeToFolder,
		RoutingFlags	flags,
		Boolean	replaceFlag
	)

routing routines AddFolderRouting()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

DisposeFolderManagerNotificationUPP()

void DisposeFolderManagerNotificationUPP

(

FolderManagerNotificationUPP

userUPP

)

DisposeFolderManagerNotificationUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0.2 and later

Mac OS X: in version 10.0 and later

FindFolder()

OSErr FindFolder	(	short	vRefNum,
		OSType	folderType,
		Boolean	createFolder,
		short *	foundVRefNum,
		long *	foundDirID
	)

FindFolder()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

FindFolderEx()

OSErr FindFolderEx	(	short	vRefNum,
		OSType	folderType,
		Boolean	createFolder,
		short *	foundVRefNum,
		long *	foundDirID,
		char *	foundFolder
	)

Since non-mac targets don't know about VRef's or DirID's, the Ex version returns the found folder path. FindFolderEx()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

FindFolderExtended()

OSErr FindFolderExtended	(	short	vol,
		OSType	foldType,
		Boolean	createFolder,
		UInt32	flags,
		void *	data,
		short *	vRefNum,
		long *	dirID
	)

FindFolderExtended()

Non-Carbon CFM: in InterfaceLib 9.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

FindFolderRouting()

OSErr FindFolderRouting	(	OSType	fileType,
		FolderType	routeFromFolder,
		FolderType *	routeToFolder,
		RoutingFlags *	flags
	)

FindFolderRouting()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

FolderManagerRegisterCallNotificationProcs()

OSStatus FolderManagerRegisterCallNotificationProcs	(	OSType	message,
		void *	arg,
		UInt32	options
	)

FolderManagerRegisterCallNotificationProcs()

Non-Carbon CFM: in InterfaceLib 9.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

FolderManagerRegisterNotificationProc()

OSErr FolderManagerRegisterNotificationProc	(	FolderManagerNotificationUPP	notificationProc,
		void *	refCon,
		UInt32	options
	)

FolderManagerRegisterNotificationProc()

Non-Carbon CFM: in InterfaceLib 9.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

FolderManagerUnregisterNotificationProc()

OSErr FolderManagerUnregisterNotificationProc	(	FolderManagerNotificationUPP	notificationProc,
		void *	refCon
	)

FolderManagerUnregisterNotificationProc()

Non-Carbon CFM: in InterfaceLib 9.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

FSFindFolder()

OSErr FSFindFolder	(	short	vRefNum,
		OSType	folderType,
		Boolean	createFolder,
		FSRef *	foundRef
	)

CALL_NOT_IN_CARBON !TARGET_OS_MAC FSFindFolder()

Non-Carbon CFM: in InterfaceLib 9.1 and later

Carbon Lib: in CarbonLib 1.1 and later

Mac OS X: in version 10.0 and later

FSFindFolderExtended()

OSErr FSFindFolderExtended	(	short	vol,
		OSType	foldType,
		Boolean	createFolder,
		UInt32	flags,
		void *	data,
		FSRef *	foundRef
	)

FSFindFolderExtended()

Non-Carbon CFM: in InterfaceLib 9.1 and later

Carbon Lib: in CarbonLib 1.1 and later

Mac OS X: in version 10.0 and later

GetFolderDescriptor()

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

GetFolderDescriptor()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

GetFolderName()

OSErr GetFolderName	(	short	vRefNum,
		OSType	foldType,
		short *	foundVRefNum,
		StrFileName	name
	)

legacy routines GetFolderName()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

GetFolderRoutings()

OSErr GetFolderRoutings	(	UInt32	requestedRoutingCount,
		UInt32 *	totalRoutingCount,
		Size	routingSize,
		FolderRouting *	theRoutings
	)

GetFolderRoutings()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

GetFolderTypes()

OSErr GetFolderTypes	(	UInt32	requestedTypeCount,
		UInt32 *	totalTypeCount,
		FolderType *	theTypes
	)

GetFolderTypes()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

IdentifyFolder()

OSErr IdentifyFolder	(	short	vRefNum,
		long	dirID,
		FolderType *	foldType
	)

IdentifyFolder()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

InvalidateFolderDescriptorCache()

OSErr InvalidateFolderDescriptorCache	(	short	vRefNum,
		long	dirID
	)

InvalidateFolderDescriptorCache()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

InvokeFolderManagerNotificationUPP()

OSStatus InvokeFolderManagerNotificationUPP	(	OSType	message,
		void *	arg,
		void *	userRefCon,
		FolderManagerNotificationUPP	userUPP
	)

InvokeFolderManagerNotificationUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0.2 and later

Mac OS X: in version 10.0 and later

NewFolderManagerNotificationUPP()

FolderManagerNotificationUPP NewFolderManagerNotificationUPP

(

FolderManagerNotificationProcPtr

userRoutine

)

NewFolderManagerNotificationUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0.2 and later

Mac OS X: in version 10.0 and later

ReleaseFolder()

OSErr ReleaseFolder	(	short	vRefNum,
		OSType	folderType
	)

ReleaseFolder()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

RemoveFolderDescriptor()

OSErr RemoveFolderDescriptor

(

FolderType

foldType

)

RemoveFolderDescriptor()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

RemoveFolderRouting()

OSErr RemoveFolderRouting	(	OSType	fileType,
		FolderType	routeFromFolder
	)

RemoveFolderRouting()

Non-Carbon CFM: in FoldersLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later