FileLib Xojo and Real Studio plugin |
|
FindFolder Method
To get one of the many pre defined system special folders, like the favorites folder, Application folder and others such then use the FindFolder function.
FindFolder(
volume as Integer,
folder as Integer,
createFolder as Boolean) as FolderItem
Parameters
- volume
- Pass the volume reference number of the volume on which you want to locate a directory. Here you can also pass a DomainType constant, and this is also the most common thing to do. (See DomainType constants ) (Windows systems will ignore this parameter)
- folder
- Pass a constant that represents the folder type to get. Refer to the FolderType constants for a complete list and documentation for each constant.
- createFolder
- If set to true then it forces creation of the folder if it does not exist. (Note: if the parent folder does not exists then the creation will fail)
Returns
- FolderItem
Remarks
Returns a FolderItem or nil if the requested folder constant is not defined on the running system. You should always expect that you could get a nil and have a alternate plan on which directory to fetch.
Supported Platforms:
MacOS X CarbonMacOS X CocoaWin32 - WindowsUnsupported Platforms:
Linux x86
See Also
GlobalMethods Global