ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

IOErrorEvent  - AS3

Packageflash.events
Classpublic class IOErrorEvent
InheritanceIOErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

An IOErrorEvent object is dispatched when an error causes input or output operations to fail.

You can check for error events that do not have any listeners by using the debugger version of Flash Player or the AIR Debug Launcher (ADL). The string defined by the text parameter of the IOErrorEvent constructor is displayed.

View the examples

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error.
ErrorEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtext : String
For a textInput event, the character or sequence of characters entered by the user.
TextEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)
Creates an Event object that contains specific information about ioError events.
IOErrorEvent
  
[override] Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original.
IOErrorEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
[override] Returns a string that contains all the properties of the IOErrorEvent object.
IOErrorEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  IO_ERROR : String = "ioError"
[static] Defines the value of the type property of an ioError event object.
IOErrorEvent
  STANDARD_ERROR_IO_ERROR : String = "standardErrorIoError"
[static] The standardErrorIoError event is dispatched when an error occurs while reading data from the standardError stream of a NativeProcess object.
IOErrorEvent
  STANDARD_INPUT_IO_ERROR : String = "standardInputIoError"
[static] The standardInputIoError event is dispatched when an error occurs while writing data to the standardInput of a NativeProcess object.
IOErrorEvent
  STANDARD_OUTPUT_IO_ERROR : String = "standardOutputIoError"
[static] The standardOutputIoError event is dispatched when an error occurs while reading data from the standardOutput stream of a NativeProcess object.
IOErrorEvent
Constructor Detail

IOErrorEvent

()Constructor
public function IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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.
 
id:int (default = 0) — A reference number to associate with the specific error (supported in Adobe AIR only).

Related API Elements

Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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 errorID=value] The errorId is only available in Adobe AIR

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
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.

Related API Elements

STANDARD_ERROR_IO_ERROR

Constant 
public static const STANDARD_ERROR_IO_ERROR:String = "standardErrorIoError"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2, Flash Lite 4

The standardErrorIoError event is dispatched when an error occurs while reading data from the standardError stream of a NativeProcess object.

This event has the following properties:

PropertyValue
bubblesNo.
cancelableNo. There is no default behavior to cancel.
errorIDThe reference number associated with the specific error.
targetThe object on which the error occurred.
textText to be displayed as an error message.

STANDARD_INPUT_IO_ERROR

Constant 
public static const STANDARD_INPUT_IO_ERROR:String = "standardInputIoError"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2, Flash Lite 4

The standardInputIoError event is dispatched when an error occurs while writing data to the standardInput of a NativeProcess object.

This event has the following properties:

PropertyValue
bubblesNo.
cancelableNo. There is no default behavior to cancel.
errorIDThe reference number associated with the specific error.
targetThe object on which the error occurred.
textText to be displayed as an error message.

STANDARD_OUTPUT_IO_ERROR

Constant 
public static const STANDARD_OUTPUT_IO_ERROR:String = "standardOutputIoError"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2, Flash Lite 4

The standardOutputIoError event is dispatched when an error occurs while reading data from the standardOutput stream of a NativeProcess object.

This event has the following properties:

PropertyValue
bubblesNo.
cancelableNo. There is no default behavior to cancel.
errorIDThe reference number associated with the specific error.
targetThe object on which the error occurred.
textText to be displayed as an error message.
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);
        }
    }
}