|
|
|
CHARACTER AbsolutePath ()
|
/** Returns the absolute path. If the path does not exist on this host, or the file on this host is not
the correct type, the unknown value is returned.
@return character An absolute (file system) representation of this path */
|
|
|
|
INTEGER CompareTo (FileInfo)
|
/* Comparison method, used by SortedSet's default comparer
FileInfo is inherited by OpenEdge.Core.File and OpenEdge.Core.Folder, so both object types can be
passed using FileInfo.
- If the returned value is less than 0 (zero), then the current object sorts before the object passed in.
- If the returned value equals 0 (zero) , then the current object occupies the same position in the sort order.
- If the returned value is greater than 0(zero), then the current object sorts after the object passed in.
- If either object's Value is the unknown value (?), then that sorts high/early/before
@param FileInfo The object to compare to (Can be type File or Folder).
@return integer 0 = same object
+1 = sorts after
-1 = sorts before */
|
|
|
|
LOGICAL Create ()
|
/* Creates the path on disk.
Note that no error is thrown from this method; FALSE is returned instead.
@return logical TRUE if the file was created. FALSE if the file already exists, or if an error wa raised during creation. */
|
|
|
|
LOGICAL Delete ()
|
/* Deletes the path on disk.
Note that no error is thrown from this method; FALSE is returned instead.
@return logical TRUE if the path was deleted. FALSE if the path does not exist, or does not have write permissions,
or if an error was raised during creation. */
|
|
|
|
CHARACTER GetShortName ()
|
/* Returns the Windows short name for this path. The absolute - resolved - path is returned. Backslashes are converted
to / for the path separator
@return character The short path. On non-Windows, or if an error is encountered, the absolute path is returned. */
|
|
|
|
LOGICAL HasAttribute (character)
|
/* Indicates whether the path has certain characteristics, as per FILE-TYPE
attributes. See https://docs.progress.com/bundle/abl-reference/page/FILE-TYPE-attribute.html for
details.
The FILE-INFO handle must be set before calling this method; this is typically done using SetFileInfo().
@param character An attribute value - a single character from the documented values
@return logical TRUE if the path exists on disk, AND is of the correct type (D or F) AND has the input attribute. FALSE otherwise */
|
|
|
|
LOGICAL HasLegalName ()
|
/* Returns a flag indicating whether the path is legal for the current OS.
@return logical TRUE if the path Name contains no illegal characters for the current platform, FALSE otherwise */
|
|
|
|
SetFileInfo ()
|
/* Sets the FILE-INFO value to represent this path */
|
|
|
|
LOGICAL StringContainsIllegalCharacters (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 */
|