flash.filesystem

# FileMode - AS3

Package | flash.filesystem
Class | public class FileMode
Inheritance | FileMode 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 constant | Reading | Writing | Creating | Truncate upon opening | Append written data
--- | --- | --- | --- | --- | ---
`READ` | • |  |  |  |
`WRITE` |  | • | • | • |
`APPEND` |  | • | • |  | •
`UPDATE` | • | • | • |  |

Related API Elements

FileStream.open()
FileStream.openAsync()

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants

| Constant | Defined By
--- | --- | ---
|  | 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
|  | READ : String = "read" [static] Used for a file to be opened in read-only mode. | FileMode
|  | UPDATE : String = "update" [static] Used for a file to be opened in read/write mode. | FileMode
|  | WRITE : String = "write" [static] Used for a file to be opened in write-only mode. | FileMode

Constant Detail

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

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

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

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00