Skip to end of metadata
Go to start of metadata

Implemented By

Supported Methods

 

The format of file and directory pathnames is described on the File System page.

Description of Methods

GetVolumeList() as Object

Returns an roList containing Strings representing the available volumes.

Volumes may be internal or external storage devices, such as "tmp:", "pkg:", "ext1:", etc.

GetDirectoryListing(String dirPath)

Returns an roList of Strings representing the directory listing of names in dirPath.

Find(dirPath as String, regEx as String) as Object

Returns an roList of Strings representing the directory listing of names in dirPath which match the regEx regular expression.  The list is not recursive; it includes only files and directories that are directly in the directory dirPath.  Each item in the list is the name of the file relative to dirPath.

FindRecurse(dirPath as String, regEx as String) as Object

Returns an roList of Strings representing the recursive directory listing of names in dirPath which match the regEx regular expression.  Each item in the list is the name of the file relative to dirPath.

Match(path as String, pattern as String) as Object

Returns an roList of Strings representing the directory listing of names in dirPath which match the shell-like pattern.  The pattern may contain wildcards like * and ?.  This method is like Find() except that it uses shell-like pattern matching rather than regular expression matching.

Exists(path as String) as Boolean

Returns true if the path exists.

Stat(path as String) as Object

Returns an roAssociativeArray containing the following keys for the passed in path:

  • type: (String) Either the value "file" or "directory"
  • size: (Integer) Number of bytes in the file. Only relevant for type "file".
  • permissions: (String) the value "rw" for read/write or "r" for read only.

GetVolumeInfo(path as String) as Object

Returns an roAssociativeArray containing information about the volume specified in path.

The path should be specified as the volume name plus a directory separator, e.g. "ext1:/".

The following keys are returned in the roAssociativeArray:

  • blocksize : (Integer) The size of the filesystem blocks in bytes.
  • blocks : (Integer) The number of blocks in the filesystem.
  • freeblocks : (Integer) The number of unused blocks in the filesystem.
  • usedblocks : (Integer) The number of used blocks in the filesystem.
  • label : (String) The volume label, if any.

Can only be called on external volumes. Internal volumes do not return meaningful information.

CreateDirectory(path as String) as Boolean

Creates the directory specified by the path parameter. All directories in path except the last one must already exist; that is, only one directory can be created.

Returns true if successful.

Delete(path as String) as Boolean

Deletes the file or directory specified by the path parameter.  If path is a directory, its contents are recursively removed.

Returns true if successful.

CopyFile(fromPath as String, toPath as String) as Boolean

Copies the file fromPath to toPath.

Returns true if successful.

Rename(fromPath as String, toPath as String) as Boolean

Renames or moves the file or directory fromPath to toPath.

If toPath exists, it is not overwritten.  Instead the operation fails and Rename returns false.

Returns true if successful.

 

  • No labels