FileSystem Object

The FileSystem object provides a native interface to perform simple and common file operations like copying, moving, and deleting, while also offering the ability to create and manage directories.

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

Name	Description
CombinePaths	Combines the specified paths.
Copy	Copies the specified file or directory sourcePath to file or directory destinationPath. When copying a directory, all files and subfolders will be copied recursively. If sourcePath does not exist, an error will be reported. If sourcePath and destinationPath are the same files, an error will be reported. If either sourcePath or destinationPath is not a regular file or directory, an error will be reported. If sourcePath is a directory, but destinationPath is a regular file, an error will be reported. An error will be reported if the copy operation is unsuccessful.
CreateDirectory	Creates the directory path. An error will be reported if the create operation is unsuccessful.
Delete	Deletes the specified file or directory path. An error will be reported if the delete operation is unsuccessful.
DirectoryList	Lists the names of files and folders contained within the specified path.
Exists	Returns 1 if the specified file or directory exists on the host computer.
FileSize	Returns the size of the file in bytes. If the specific path is a directory or the file does not exist, an error will be reported.
GetCreationDate	Gets the time of creation of the file or directory located at path.
GetFileDirectory	Returns the directory of the file located at path.
GetFileExtension	Returns the extension of the file located at path. The extension of the file consists of any characters present after the rightmost period.
GetFileName	Returns the file name of the file located at path.
GetFileTitle	Returns the title of the file located at path.
GetLastModifiedDate	Time of last modification of the file or directory.
HaveReadPermission	Returns 1 if the current user has read permission for the specified path.
HaveWritePermission	Returns 1 if the current user has write permission for the specified path.
IsDirectory	Returns 1 if the specified path is a directory.
IsXML	Returns 1 if the specified path appears to be an XML file. This determination is made by checking to see if the first six characters are "<?xml".
Move	Moves the specified file or directory sourcePath to the destinationPath. When moving a directory, all files and subfolders will be moved, recursively. In the event that the move operation overwrites existing files or directories, the move is not atomic. An error will be reported if the move operation is unsuccessful.
Rename	Renames the specified file or directory sourcePath to the destinationPath. When moving a directory, all files and subfolders will be renamed, recursively. In the event that the rename operation overwrites existing files or directories, the rename is not atomic. An error will be reported if the rename operation is unsuccessful.

FileSystem Object

Description

Available In Editions:

Timing Precision Mode