|
Options |
Name |
Purpose |
|
|
|
CHARACTER AbsoluteFileName ()
|
/** Returns the absolute file name of this object, if the file exists. Resolved using FILE-INFO
@param character An absolute path. If the file does not exist, or cannot be resolved, the unknown value is returned */
|
|
|
|
LOGICAL CanCreateFile ()
|
/** Returns a logical value indicating whether the file can be created.
If the Name already exists (as any type), then FALSE is returned.
If the Folder exists, and is either a FILE or not writable, then FALSE is returned.
If the Folder does not exist, then return the value of the CanCreateFolder() method.
Otherwise return TRUE.
@return logical TRUE if the file can be created, FALSE otherwise */
|
|
|
|
LOGICAL CanCreateFolder ()
|
/** Returns a logical value indicating whether the folder can be created.
If any of the parent folders are not directories or are not writable, then
return FALSE.
Otherwise return TRUE.
@return logical TRUE if the folder can be created, FALSE otherwise */
|
|
|
|
LOGICAL CanWriteToFile ()
|
/* Indicates whether a file can be written to.
@return logical TRUE if the file exists and can be written to. FALSE otherwise. */
|
|
|
|
LOGICAL CanWriteToFolder ()
|
/* Indicates whether the file's folder can be written to.
If none of the folders exist then this method returns TRUE
@return logical TRUE if the file exists and can be written to. FALSE otherwise. */
|
|
|
|
LOGICAL ContainsIllegalCharacters (character)
|
/* Indicates whether a string has illegal characters anywhere in it.
@param character A string to check
@return logical TRUE if the string is not-null, and has at least one illegal character in it; FALSE otherwise */
|
|
|
|
LOGICAL CreateFile ()
|
/* Creates an empty file on disk.
This method does NOT check whether the file can be created (via CanCreateFile), but rather simply tries
to create the file, and returns FALSE if it fails.
@return logical TRUE if the file was created. FALSE if the file already exists, or if an error wa raised during creation. */
|
|
|
|
LOGICAL CreateFolder ()
|
/* Creates this file's Folder
This method does NOT check whether the folder can be created (via CanCreateFolder), but rather simply tries
to create the folder tree, 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 Equals (Object)
|
|
|
|
|
FileInfoFindExistingParent (character)
|
/* Find the first/nearest existing folder for a path. A path may be a folder
or a file.
@param character A path. */
|
|
|
|
LOGICAL FileInfoIsFileAndWritable ()
|
/* Checks if the current FILE-INFO is a FILE and has the WRITE flag
set.
@return logical TRUE if the current file-info is a file, and has the write flag set; FALSE otherwise */
|
|
|
|
LOGICAL FileInfoIsFolderAndWritable ()
|
/* Checks if the current FILE-INFO is a DIRECTORY and has the WRITE flag
set.
@return logical TRUE if the current file-info is a directory, and has the write flag set; FALSE otherwise */
|
|
|
|
FileInfoSetToFolder ()
|
/* Set the FILE-INFO FILE-NAME to the folder for this File. Uses "." if the folder is empty. */
|
|
|
|
CHARACTER GetSplitPath ()
|
/** Returns an array of path entries
@return character[] May be indeterminate if the path is empty */
|
|
|
|
SplitFileName (character)
|
/* Splits a /-delimited file name into its component parts
@param character A complete file name */
|
|
|
|
CHARACTER ToString ()
|
|