FileProperties Object

Description

The FileProperties object is used to query information about a file, in contrast to the FileInterface, which is used to determine information within a file. The FileProperties object provides a mechanism to retrieve the contents of a directory (DirectoryList) and determine if a filename points to a directory or a file (isDirectory).

This object has been Deprecated. Please use the static FileSystem object instead.

Inheritance Hierarchy: Object->FileProperties

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Properties

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DisplayName	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

Methods

Name	Description
ClearSavedStates	Clears previous saved states for this object.
DirectoryList	If the FileProperties.Filename property refers to a directory, the argument StringArray will be populated with the names of the files and folders in the directory. This method returns the number of files and folders in the named directory.
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.

Deprecated Properties

Name

Description

Attributes

Exists

Returns 1 if the specified file/directory exists on the host computer.