Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.filesystem 
FileMode 
Packageflash.filesystem
Classpublic class FileMode
InheritanceFileMode Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The FileMode class defines string constants used in the fileMode parameter of the open() and openAsync() methods of the FileStream class. The fileMode parameter of these methods determines the capabilities available to the FileStream object once the file is opened.

The following capabilities are available, in various combinations, based on the fileMode parameter value specified in the open method:

  • Reading—The FileStream object can read data from the file.
  • Writing—The FileStream object can write data to the file.
  • Creating—The FileStream object creates a nonexistent file upon opening.
  • Truncate upon opening—Data in the file is deleted upon opening (before any data is written).
  • Append written data—Data is always written to the end of the file (when any write method is called).

The following table shows the capabilities that each constant in the FileMode class provides when applied as the fileMode parameter of an open method of a FileStream object:

FileMode constantReadingWritingCreatingTruncate upon openingAppend written data
READ
WRITE
APPEND
UPDATE

See also



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  AIR-only APPEND : String = "append"
[static] Used for a file to be opened in write mode, with all written data appended to the end of the file.
FileMode
  AIR-only READ : String = "read"
[static] Used for a file to be opened in read-only mode.
FileMode
  AIR-only UPDATE : String = "update"
[static] Used for a file to be opened in read/write mode.
FileMode
  AIR-only WRITE : String = "write"
[static] Used for a file to be opened in write-only mode.
FileMode
Constant Detail
AIR-only 

APPEND

Constant
public static const APPEND:String = "append"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Used for a file to be opened in write mode, with all written data appended to the end of the file. Upon opening, any nonexistent file is created.

AIR-only 

READ

Constant 
public static const READ:String = "read"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Used for a file to be opened in read-only mode. The file must exist (missing files are not created).

AIR-only 

UPDATE

Constant 
public static const UPDATE:String = "update"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Used for a file to be opened in read/write mode. Upon opening, any nonexistent file is created.

AIR-only 

WRITE

Constant 
public static const WRITE:String = "write"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Used for a file to be opened in write-only mode. Upon opening, any nonexistent file is created, and any existing file is truncated (its data is deleted).