file.getSpecialFolderPath
| Syntax |
file.getSpecialFolderPath (vol, folder, create)
|
| Params |
vol is the name of the volume on which the special folder's location is to be determined. If vol is the empty string, the current boot disk is used. folder is the standard U. S. name of the special folder whose path is to be determined. Possible values are: Mac OS: "Apple Menu Items" "Control Panels" "Desktop Folder" "Extensions" "Fonts" "Preferences" "PrintMonitor Documents" "Startup Items" "System Folder" "Temporary Items" "Trash" Windows: "Desktop" "DesktopDirectory" "Fonts" "NetHood" "Personal" "Preferences" "Programs" "Recent" "SendTo" "StartMenu" "StartUp" "System" "Temp" "Templates" "Windows" create is a boolean value indicating whether or not the desired folder should be created if it doesn't exist on vol.
|
| Action |
Looks on the indicated volume for the special folder, and creates it if necessary. On Windows, the vol and create parameters are ignored; the requested folder is not created if it does not exist. The Preferences folder in Windows is a folder named Preferences in the same folder as the Frontier.root file.
|
| Returns |
The full path name of the requested folder.
|
| Examples |
file.getSpecialFolderPath ("", "Desktop", false) "C:\\WINNT\\Profiles\\Wes\\DESKTOP"
file.getSpecialFolderPath ("", "DesktopDirectory", false)
file.getSpecialFolderPath ("", "System", false)
file.getSpecialFolderPath ("", "System", false)
This call is equivalent to file.getSystemFolderPath
If the folder did not exist before the call, it was created. |
| Errors |
If the folder parameter is not valid, or the requested folder could not be found or created, an error is generated. If the desired folder belongs in the System Folder and the volume does not contain a System Folder, no System Folder will be created, and an error will occur.
|
| Notes |
Case is not significant in the folder parameter, and the word "Items" or "Folder" may be left out of those names in which it appears.
|
| See Also |
file.getSystemFolderPath
|
