NAME

Mac::Files - Macintosh Toolbox Interface to the File and Alias Manager

SYNOPSIS

DESCRIPTION

Constants

kOnSystemDisk

kCreateFolder

kDontCreateFolder

Constants for Folder Manager.

kALMLocationsFolderType

Specifies the Locations folder in the Location Manager Prefs folder. Files containing configuration information for different locations are stored here. Supported with Mac OS 8.1 and later.

kALMModulesFolderType

Specifies the Location Manager Modules folder in the Extensions Folder. Supported with Mac OS 8.1 and later.

kALMPreferencesFolderType

Specifies the Location Manager Prefs folder in the Preferences folder. Supported with Mac OS 8.1 and later.

kAppearanceFolderType

Specifies the Appearance folder in the System Folder. Supported with Mac OS 8.5 and later.

kAppleExtrasFolderType

Specifies the Apple Extras folder installed at the root level of the volume. Supported with Mac OS 8 and later.

kAppleMenuFolderType

Specifies the Apple Menu Items folder in the System Folder.

kApplicationSupportFolderType

Specifies the Application Support folder in the System Folder. This folder contains code and data files needed by third-party applications. These files should usually not be written to after they are installed. In general, files deleted from this folder remove functionality from an application, unlike files in the Preferences folder, which should be non-essential. One type of file that could be placed here would be plug-ins that the user might want to maintain separately from any application, such as for an image-processing application that has many "fourth-party" plug-ins that the user might want to upgrade separately from the host application. Another type of file that might belong in this folder would be application-specific data files that are not preferences, such as for a scanner application that needs to read description files for specific scanner models according to which are currently available on the SCSI bus or network. Supported with Mac OS 8 and later.

kApplicationsFolderType

Specifies the Applications folder installed at the root level of the volume. Supported with Mac OS 8 and later.

kAssistantsFolderType

Specifies the Assistants folder installed at the root level of the volume. Supported with Mac OS 8 and later.

kChewableItemsFolderType

Specifies the invisible folder on the system disk called "Cleanup at Startup" whose contents are deleted when the system is restarted, instead of merely being moved to the Trash. When the FindFolder function indicates this folder is available (by returning noErr ), developers should usually use this folder for their temporary items, in preference to the Temporary Folder. Supported with Mac OS 8 and later.

kColorSyncProfilesFolderType

Specifies the ColorSync Profiles folder in the System Folder. Supported with Mac OS 8.1 and later.

kContextualMenuItemsFolderType

Specifies the Contextual Menu Items folder in the System Folder. Supported with Mac OS 8 and later.

kControlPanelDisabledFolderType

Specifies the Control Panels (Disabled) folder in the System Folder. Supported with Mac OS 8 and later.

kControlPanelFolderType

Specifies the Control Panels folder in the System Folder.

kControlStripModulesFolderType

Specifies the Control Strip Modules folder in the System Folder. Supported with Mac OS 8 and later.

kCurrentUserFolderType

The folder for the currently logged on user.

kCurrentUserRemoteFolderLocation

The remote folder for the currently logged on user

kCurrentUserRemoteFolderType

The remote folder location for the currently logged on user

kDesktopFolderType

Specifies the Desktop Folder.

kDesktopPicturesFolderType

Specifies the Desktop Pictures folder in the Appearance folder. This folder is used for storing desktop picture files. Files of type 'JPEG' are auto-routed into this folder when dropped into the System Folder. Supported with Mac OS 8.5 and later.

kDisplayExtensionsFolderType

Display Extensions Folder (in Extensions folder)

kDocumentsFolderType

Specifies the Documents folder. This folder is created at the volume root. Supported with Mac OS 8 and later.

kEditorsFolderType

Specifies the OpenDoc editors folder in the Mac OS folder. Supported with Mac OS 8 and later.

kExtensionDisabledFolderType

Specifies the Extensions (Disabled) folder in the System Folder. Supported with Mac OS 8 and later.

kExtensionFolderType

Specifies the Extensions folder in the System Folder.

kFavoritesFolderType

Specifies the Favorites folder in the System Folder. This folder is for storing Internet location files, aliases, and aliases to other frequently used items. Facilities for adding items into this folder are found in Contextual Menus, the Finder, Navigation Services, and others. Supported with Mac OS 8.1 and later.

kFindByContentFolderType

Specifies the Find By Content folder installed at the root level of the volume. This folder is invisible and its use is private to Find By Content. Supported with Mac OS 8.5 and later.

kFindByContentPluginsFolderType

Find By Content Plug-ins

kFindSupportFolderType

Specifies the Find folder in the Extensions folder. This folder contains files used by the Find application. Supported with Mac OS 8.5 and later.

kFolderActionsFolderType

Specifies the Folder Action Scripts folder in the Scripts folder. Supported with Mac OS 8.5 and later.

kFontsFolderType

Specifies the Fonts folder in the System Folder.

kGenEditorsFolderType

Specifies a general editors folder. Supported with Mac OS 8 and later.

kHelpFolderType

Specifies the Help folder in the System Folder. Supported with Mac OS 8 and later.

kInstallerLogsFolderType

Specifies the Installer Logs folder installed at the root level of the volume. You can use this folder to save installer log files. Supported with Mac OS 8.5 and later.

kInternetFolderType

Specifies the Internet folder installed at the root level of the volume. This folder is a location for saving Internet-related applications, resources, and tools. Supported with Mac OS 8.5 and later.

kInternetPlugInFolderType

Specifies the Browser Plug-ins folder in the System Folder. Supported with Mac OS 8 and later.

kInternetSearchSitesFolderType

Specifies the Internet Search Sites folder in the System Folder. This folder contains Internet search site specification files used by the Find application when it accesses Internet search sites. Files of type 'issp' are auto-routed to this folder. Supported with Mac OS 8.5 and later.

kKeychainFolderType

Keychain folder

kLauncherItemsFolderType

Specifies the Launcher Items folder in the System Folder. Items in this folder appear in the Launcher control panel. Items included in folders with names beginning with a bullet (Option-8) character will appear as a separate panel in the Launcher window. Supported with Mac OS 8.5 and later.

kLocalesFolderType

PKE for Locales folder

kMacOSReadMesFolderType

Specifies the Mac OS Read Me Files folder installed at the root level of the volume. Supported with Mac OS 8 and later.

kModemScriptsFolderType

Specifies the Modem Scripts folder in the Extensions folder. Supported with Mac OS 8 and later.

kMultiprocessingFolderType

Multiprocessing Folder (in Extensions folder)

kOpenDocEditorsFolderType

Specifies the OpenDoc subfolder in the Editors folder. Supported with Mac OS 8 and later.

kOpenDocFolderType

Specifies the OpenDoc root folder. Supported with Mac OS 8 and later.

kOpenDocLibrariesFolderType

Specifies the OpenDoc libraries folder. Supported with Mac OS 8 and later.

kOpenDocShellPlugInsFolderType

Specifies the OpenDoc shell plug-ins folder in the OpenDoc folder. Supported with Mac OS 8 and later.

kPreferencesFolderType

Specifies the Preferences folder in the System Folder.

kPrintMonitorDocsFolderType

Specifies the PrintMonitor Documents folder in the System Folder.

kPrinterDescriptionFolderType

Specifies the Printer Descriptions folder in the Extensions folder. Supported with Mac OS 8 and later.

kPrinterDriverFolderType

Specifies the printer drivers folder. This constant is not currently supported.

kPrintingPlugInsFolderType

Printing Plug-Ins Folder (in Extensions folder)

kQuickTimeExtensionsFolderType

QuickTime Extensions Folder (in Extensions folder)

kRecentApplicationsFolderType

Specifies the Recent Applications folder in the Apple Menu Items folder. Apple Menu Items saves aliases to recent applications here. Supported with Mac OS 8.5 and later.

kRecentDocumentsFolderType

Specifies the Recent Documents folder in the Apple Menu Items folder. Apple Menu Items saves aliases to recently opened documents here. Supported with Mac OS 8.5 and later.

kRecentServersFolderType

Specifies the Recent Servers folder in the Apple Menu Items folder. Apple Menu Items saves aliases to recently mounted servers here. Supported with Mac OS 8.5 and later.

kScriptingAdditionsFolderType

Specifies the Scripting Additions folder in the System Folder. Supported with Mac OS 8 and later.

kScriptsFolderType

Specifies the Scripts folder in the System Folder. This folder is for saving AppleScript scripts. Supported with Mac OS 8.5 and later.

kSharedLibrariesFolderType

Specifies the general shared libraries folder. This constant is not currently supported.

kSharedUserDataFolderType

A Shared "Documents" folder, readable & writeable by all users

kShutdownFolderType

Specifies the Shutdown Items folder in the System Folder.

kShutdownItemsDisabledFolderType

Specifies the Shutdown Items (Disabled) folder in the System Folder. Supported with Mac OS 8 and later.

kSoundSetsFolderType

Specifies the Sound Sets folder in the Appearance folder. Supported with Mac OS 8.5 and later.

kSpeakableItemsFolderType

Specifies the Speakable Items folder. This folder is for storing scripts and items recognized by speech recognition. Supported with Mac OS 8.5 and later.

kStartupFolderType

Specifies the Startup Items folder in the System Folder.

kStartupItemsDisabledFolderType

Specifies the Startup Items (Disabled) folder in the System Folder. Supported with Mac OS 8 and later.

kStationeryFolderType

Specifies the OpenDoc stationery folder. Supported with Mac OS 8 and later.

kSystemControlPanelFolderType

System control panels folder - never the redirected one, always "Control Panels" inside the System Folder

kSystemDesktopFolderType

the desktop folder at the root of the hard drive, never the redirected user desktop folder

kSystemExtensionDisabledFolderType

Specifies the System Extensions (Disabled) folder in the System Folder. Supported with Mac OS 8 and later.

kSystemFolderType

Specifies the System Folder.

kSystemPreferencesFolderType

System-type Preferences go here - this is always the system's preferences folder, never a logged in user's

kSystemTrashFolderType

the trash folder at the root of the drive, never the redirected user trash folder

kTemporaryFolderType

Specifies the Temporary folder. This folder exists as an invisible folder at the volume root.

kTextEncodingsFolderType

Specifies the Text Encodings folder in the System Folder. Supported with Mac OS 8 and later.

kThemesFolderType

Specifies the Theme Files folder in the Appearance folder. Supported with Mac OS 8.1 and later.

kTrashFolderType

Specifies the single-user Trash folder.

kUsersFolderType

"Users" folder, contains one folder for each user.

kUtilitiesFolderType

Specifies the Utilities folder installed at the root level of the volume. Supported with Mac OS 8 and later.

kVoicesFolderType

Specifies the Voices folder in the Extensions folder. Supported with Mac OS 8 and later.

kVolumeRootFolderType

Specifies the root folder of a volume. Supported with Mac OS 8 and later.

kVolumeSettingsFolderType

Volume specific user information goes here

kWhereToEmptyTrashFolderType

Specifies the shared Trash folder; on a file server, this indicates the parent directory of all logged-on users' Trash subdirectories.

asiZoneName

Return AppleTalk zone name from GetAliasInfo.

asiServerName

Return AppleTalk server name from GetAliasInfo.

asiVolumeName

Return volume name from GetAliasInfo.

asiAliasName

Return last component of target file name from GetAliasInfo.

asiParentName

Return name of enclosing folder from GetAliasInfo. This index value is 1. Higher indices will return folder names higher up the hierarchy.

AUTHOR

Matthias Ulrich Neeracher <neeracher@mac.com>