Error getting tags :
error 404Error getting tags :
error 404 specialFolderPath | revDocs | RunRev
Welcome Guest (Log in)
Product Edition
Version
specialFolderPath
Basics
Expander triangle
Type
Function
Syntax

the specialFolderPath of folderIdentifier

specialFolderPath(folderIdentifier)

Introduced
1.1
Changed
2.9
Environment
Desktop, Web and Server
Platform Support
MacOS,Mac OS X,Windows,Linux
Security
Disk
Summary
Returns the names and locations of system-related folders.
Examples

specialFolderPath("Preferences")
set the defaultFolder to specialFolderPath("desktop")
put specialFolderPath("asup") into appSupportFolder

Additional Comments
Expander triangle

Use the specialFolderPath function to place preferences in the Preferences folder, save files to the Documents folder, find out which files are installed in the System or Fonts folders, and so on.

Parameters:

The folderIdentifier is one of the following:

For Mac OS systems:

Desktop: The Desktop folder, where files or folders on the desktop are placed

System: The active System Folder

Apple: The Apple Menu Items folder inside the System Folder

Control: The Control Panels folder inside the System Folder

Extension: The Extensions folder inside the System Folder

Fonts: The Fonts folder inside the System Folder

Preferences: The Preferences folder inside the System Folder

Temporary: For storage of temporary files

For OS X systems:

Home: The current user's home directory (e.g. "/Users/Fred")

Desktop: The user's Desktop folder

System: The active System Folder

Fonts: The system Fonts folder

Preferences: The Preferences folder inside the user's Library folder

Temporary: For storage of temporary files

Documents: For user documents

For Mac OS and OS X systems, you can also specify a four-character special folder constant as the folderIdentifier. You can find a list of these constants on the Apple web site at <http://developer.apple.com/documentation/Carbon/Reference/Folder_Manager/Reference/reference.html#//apple_ref/c/tdef/FolderType>.

Note: Some special folder constants are meaningful only on Mac OS or only on OS X but not both. Not all special folder constants work on all system versions.

For Windows systems:

Home : The current user's home directory (e.g. "C:/Documents and Settings/Fred")

Desktop: For icons on the desktop

System: For system components

Start: For items in the Start menu

Documents: For user documents

Fonts: For font storage

Temporary: For storage of temporary files

For Windows systems, you can also specify a CSIDL number that identifies a special folder. Some Commonly used CSIDL values are:

0x001a: The user application data folder (e.g. "C:/Documents and settings/Fred/Application Data")

0x0023: The "all users" application data folder (e.g. "C:/Documents and settings/all users/Application Data")

0x000d: The "My Music" folder

0x000e: The "My Videos" folder

0x0027: The "My Pictures" folder

0x000a: The recycle bin

You can find a complete list of available CDISL values on the Microsoft web site at <http://vbnet.mvps.org/index.html?code/browse/csidlversions.htm>.

Note: Not all CSIDL numbers work on all Windows versions, refer to the link above to find out more about CSIDLs.

For Unix systems:

Home: The current user's home directory (e.g. "/home/fred")

Desktop: The current user's desktop (e.g. "/home/fred/Desktop")

Temporary: For storage of temporary files (typically "/tmp")

Value:

The specialFolderPath function returns a folder name and location.

Comments:

If the folder is not found, the specialFolderPath function returns empty. If the folderIdentifier is either not supported on the current platform or doesn't exist on the current system, the result is set to "folder not found".

Some of the special folders you can specify with the specialFolderPath function need not have the standard names. (For example, the System Folder on Mac OS systems is not necessarily named "System Folder".) For this reason, the specialFolderPath function returns the full path to the folder, including the name of the folder.

Changes to Revolution:

Support for using the specialFolderPath function on Unix systems was added in version 2.9

Support for special folder constants (on Mac OS and OS X) and CSIDL numbers (on Windows) was added in version 2.0.

User Comments
Expander triangle