ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
IOErrorEvent

Package | flash.events
Class | public class IOErrorEvent
Inheritance | IOErrorEvent ErrorEvent TextEvent Event Object

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Flash® Player dispatches an IOErrorEvent object when an error causes a send or load operation to fail.

You can check for error events that do not have any listeners by using the debugger version of Flash Player. Flash Player displays the string defined by the `text` parameter of the IOErrorEvent constructor. There is only one type of input/output error event: `IOErrorEvent.IO_ERROR`.

View the examples

See also

IO_ERROR

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | prototype : Object [static] A reference to the prototype object of a class or function object. | Object
|  | target : Object [read-only] The event target. | Event
|  | text : String For a textInput event, the character or sequence of characters entered by the user. | TextEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "") Creates an Event object that contains specific information about ioError events. | IOErrorEvent
|  | clone():Event Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original. | IOErrorEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in your custom Event class. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether preventDefault() has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | 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
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toString():String Returns a string that contains all the properties of the IOErrorEvent object. | IOErrorEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ACTIVATE : String = "activate" [static] Defines the value of the type property of an activate event object. | Event
|  | ADDED : String = "added" [static] Defines the value of the type property of an added event object. | Event
|  | ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object. | Event
|  | CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object. | Event
|  | CHANGE : String = "change" [static] Defines the value of the type property of a change event object. | Event
|  | CLEAR : String = "clear" [static] Defines the value of the type property of a clear event object. | Event
|  | CLOSE : String = "close" [static] Defines the value of the type property of a close event object. | Event
|  | COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object. | Event
|  | CONNECT : String = "connect" [static] Defines the value of the type property of a connect event object. | Event
|  | COPY : String = "copy" [static] Defines the value of the type property of a copy event object. | Event
|  | CUT : String = "cut" [static] Defines the value of the type property of a cut event object. | Event
|  | DEACTIVATE : String = "deactivate" [static] Defines the value of the type property of a deactivate event object. | Event
|  | ENTER_FRAME : String = "enterFrame" [static] Defines the value of the type property of an enterFrame event object. | Event
|  | ERROR : String = "error" [static] Defines the value of the type property of an error event object. | ErrorEvent
|  | EXIT_FRAME : String = "exitFrame" [static] Defines the value of the type property of an exitFrame event object. | Event
|  | FRAME_CONSTRUCTED : String = "frameConstructed" [static] Defines the value of the type property of an frameConstructed event object. | Event
|  | FULLSCREEN : String = "fullScreen" [static] Defines the value of the type property of a fullScreen event object. | Event
|  | ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object. | Event
|  | INIT : String = "init" [static] Defines the value of the type property of an init event object. | Event
|  | IO_ERROR : String = "ioError" [static] Defines the value of the type property of an ioError event object. | IOErrorEvent
|  | LINK : String = "link" [static] Defines the value of the type property of a link event object. | TextEvent
|  | MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the type property of a mouseLeave event object. | Event
|  | OPEN : String = "open" [static] Defines the value of the type property of an open event object. | Event
|  | PASTE : String = "paste" [static] Defines the value of the type property of a paste event object. | Event
|  | REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object. | Event
|  | REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object. | Event
|  | RENDER : String = "render" [static] Defines the value of the type property of a render event object. | Event
|  | RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object. | Event
|  | SAMPLE_DATA : String = "sampleData" [static] Defines the value of the type property of a sampleData event object. | Event
|  | SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object. | Event
|  | SELECT : String = "select" [static] Defines the value of the type property of a select event object. | Event
|  | SELECT_ALL : String = "selectAll" [static] Defines the value of the type property of a selectAll event object. | Event
|  | SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the type property of a soundComplete event object. | Event
|  | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object. | Event
|  | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object. | Event
|  | TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object. | Event
|  | TEXT_INPUT : String = "textInput" [static] Defines the value of the type property of a textInput event object. | TextEvent
|  | UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object. | Event

Constructor Detail

IOErrorEvent | () | Constructor

`public function IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "")`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Creates an Event object that contains specific information about `ioError` events. Event objects are passed as parameters to Event listeners.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. There is only one type of input/output error event: `IOErrorEvent.IO_ERROR`.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited `bubbles` property.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.
| `text:String` (default = "``")`` — Text to be displayed as an error message. Event listeners can access this information through the `text` property.

See also

IO_ERROR
Method Detail

clone | () | method

`override public function clone():Event`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new IOErrorEvent object with property values that match those of the original.

toString | () | method |

`override public function toString():String`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Returns a string that contains all the properties of the IOErrorEvent object. The string is in the following format:

`[IOErrorEvent type=value bubbles=value cancelable=value text=value]`

Returns

| `String` — A string that contains all the properties of the IOErrorEvent object.

Constant Detail

IO_ERROR | Constant

`public static const IO_ERROR:String = "ioError"`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Defines the value of the `type` property of an `ioError` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`target` | The network object experiencing the input/output error.
`text` | Text to be displayed as an error message.

See also

flash.display.LoaderInfo.ioError
flash.media.Sound.ioError
flash.net.Socket.ioError
flash.net.FileReference.ioError
flash.net.NetConnection.ioError
flash.net.NetStream.ioError
flash.net.URLLoader.ioError
flash.net.URLStream.ioError
flash.net.XMLSocket.ioError
Examples How to use examples
IOErrorEventExample.as
The following example uses the `IOErrorEventExample` class to show how an error event object is dispatched when an attempt is made to load a nonexistent file. The example carries out the following tasks:

1. The class constructor creates a new instance of a URLLoader object and assigns it to the variable `loader`.
2. The URLLoader instance instantiates an event listener of type `ioError`, which has an associated subscriber method `ioErrorHandler()`, which simply prints information about the event using `trace()`.
3. Next, the constructor creates a new instance of a URLRequest object, `request`, passing `MissingFile.xml` so that the name and location of the missing file are known.
4. The `request` variable is then passed to `loader.load()`, which attempts to load the missing file. Since the file is missing, the event handler dispatches an `ioError` event.

Notes:

- You need to compile the SWF file with "Local Playback Security" set to "Access Local Files Only".
- Make sure that you do not have a file named "MissingFile.xml" at the same level as your SWF file.

    package {
        import flash.display.Sprite;
        import flash.events.IOErrorEvent;
        import flash.net.URLLoader;
        import flash.net.URLRequest;

        public class IOErrorEventExample extends Sprite {
            public function IOErrorEventExample() {
                var loader:URLLoader = new URLLoader();
                loader.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);

                var request:URLRequest = new URLRequest("MissingFile.xml");
                loader.load(request);
            }

            private function ioErrorHandler(event:IOErrorEvent):void {
                trace("ioErrorHandler: " + event);
            }
        }
    }

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00