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

NativeProcessExitEvent  - AS3

Packageflash.events
Classpublic class NativeProcessExitEvent
InheritanceNativeProcessExitEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

This event is dispatched by the NativeProcess object when the process exits. It is possible that this event will never be dispatched. For example, if the child process outlives the AIR application that created it, the event will not dispatch.

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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
      exitCode : Number
The exit code that the native process returned to the host operating system when exiting.
NativeProcessExitEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    NativeProcessExitEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, exitCode:Number = NaN)
Creates a NativeProcessExitEvent which contains specific information regarding a NativeProcess's exit code
NativeProcessExitEvent
  
    clone():Event
[override] Creates a copy of the NativeProcessExitEvent object and sets each property's value to match that of the original.
NativeProcessExitEvent
 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
  
    toString():String
[override] Returns a string that contains all the properties of the NativeProcessExitEvent object.
NativeProcessExitEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      EXIT : String = "exit"
[static] Defines the value of the type property of a exit event object.
NativeProcessExitEvent
Property Detail
    

exitCode

property
exitCode:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

The exit code that the native process returned to the host operating system when exiting. If the AIR application terminates the process by calling the exit() method of the NativeProcess object, the exitCode property is set to NaN. NOTE: on windows operating systems if the process has not exited but the runtime is exiting or an error occurred this value may be set to 259 (STILL_ACTIVE). To avoid confusion of this condition, do not use 259 as a return code in a native process.



Implementation
    public function get exitCode():Number
    public function set exitCode(value:Number):void
Constructor Detail
    

NativeProcessExitEvent

()Constructor
public function NativeProcessExitEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, exitCode:Number = NaN)

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

Creates a NativeProcessExitEvent which contains specific information regarding a NativeProcess's exit code

Parameters
type:String — The type of the event, accessible as Event.type.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. The default values is false.
 
exitCode:Number (default = NaN) — Number that the process returned to the operating system during exit.
Method Detail

    clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 2, AIR 2

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

Returns
Event — A new NativeProcessExitEvent 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 2, AIR 2

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

[NativeProcessExitEvent type=value bubbles=value cancelable=value exitCode=value]

Returns
String — A string that contains all the properties of the ProgressEvent object.
Constant Detail
    

EXIT

Constant
public static const EXIT:String = "exit"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

Defines the value of the type property of a exit event object.