|
|
CHARACTER AbsolutePath ()
|
/** Returns the absolute path.
If the path does not exist on this host, the unknown value is returned.
For Windows, any short paths - like C:\PROGRA~1 - are converted into their long paths - C:\Program Files.
Backslashes are are converted to /
@return character An absolute (file system) representation of this path */
|
|
|
Add (File)
|
/* Adds a file to this folder.
The input file's basename is used to create a new File instance, that has this folder as
the folder. So if this folder is "/some/path" , and a file "foo.pdf" is added, then the
new file has a name of "/some/path/foo.pdf".
Similarly, if a file "bar/baz.png" is added, then the new file has a name of "/some/path/baz.png".
@param File A file to add */
|
|
|
Add (Folder)
|
/* Adds a sub-folder to this folder. The 'basename' of the folder is added to this folder.
The 'basename' is the last path segment.
If it is blank or / or // an error is thrown
@param Folder The sub folder */
|
|
|
LOGICAL Create ()
|
/* Creates this folder, if it does not exist
This method does NOT check whether the folder can be created (via CanCreateFolder), but rather simply tries
to create the folder, and returns FALSE if it fails.
@return logical TRUE if the Folder was created. FALSE if the Folder already exists, or if an error was raised during creation */
|
|
|
LOGICAL Delete ()
|
/* Deletes this folder on disk. The folder, its files and any subfolders are deleted.
@return logical TRUE if the folder exists, and has write permissions, and was deleted without any errors.
FALSE otherwise */
|
|
|
FileInfoFindExistingParent (character)
|
/* Find the first/nearest existing folder for a path. A path may be a folder
or a file.
@param character A path. */
|
|
|
ReadFolder (integer)
|
/* Reads the contents of a folder, to a given depth.
Depth value:
-n = Don't read this folder, at all
0 = Read the current folder. Read files and folders, but don't read child folders' contents
? = read all the way down. Read all files and child folders
n = read up to specified depth. At lowest level, read files and child folders, but not folders' contents
@param integer The depth to read to. */
|
|
|
SetFileInfo ()
|
/* Set the FILE-INFO FILE-NAME for this Folder. Uses "." if the folder Name is empty. */
|