FileProperties Object

 Top  Previous  Next

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 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.

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

 

Properties

 

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

 
 

 

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.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

Filename

The name of the file or folder.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   String

Access: Read/Write

FileSize

Returns the size of the file in bytes. If the specific path is a directory or the file does not exist, then a value of -1 will be returned.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

isDirectory

Returns 1 if the specified path is a directory, rather than a file.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

isReadOnly

Returns 1 if the specified path is read-only.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

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 ".

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

TimeCreated

Time of creation of file.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

Units:   day

TimeLastModified

Time of last modification of file.

 

This property has been Deprecated. Please use the static methods on FileSystem instead.

Type:   Variable

Access: Read-Only

Units:   day

 
 

 

 

See also

Interfacing with Files Guide