ArgumentError

Package	Top Level
Class	public dynamic class ArgumentError
Inheritance	ArgumentError Error Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 9, AIR 1.0

The ArgumentError class represents an error that occurs when the arguments supplied in a function do not match the arguments defined for that function. This error occurs, for example, when a function is called with the wrong number of arguments, an argument of the incorrect type, or an invalid argument.

View the examples

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
		errorID : int [read-only] Contains the reference number associated with the specific error message.	Error
		message : String Contains the message associated with the Error object.	Error
		name : String Contains the name of the Error object.	Error
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ArgumentError(message:String = "") Creates an ArgumentError object.	ArgumentError
		getStackTrace():String Returns the call stack for an error as a string at the time of the error's construction (for the debugger version of Flash Player and the AIR Debug Launcher (ADL) only; returns null if not using the debugger version of Flash Player or the ADL.	Error
		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 [override] Returns the string "Error" by default or the value contained in the Error.message property, if defined.	Error
		valueOf():Object Returns the primitive value of the specified object.	Object

Constructor Detail

()

Constructor

public function ArgumentError(message:String = "")

Runtime Versions:

AIR 1.0, Flash Player 9

Creates an ArgumentError object.

Parameters

message:String (default = "") — A string associated with the error.

Examples ( How to use this example )

ArgumentErrorExample.as

The following example shows how an ArgumentError error is generated and handled within a try..catch statement. The println() function takes one argument, a single string, but because two strings are supplied, the error is thrown. Typically, the compiler might catch such an error, but the this[] syntax in the try statement bypasses the compiler's syntax checking for the function.

package {
    import flash.display.Sprite;
    
    public class ArgumentErrorExample extends Sprite {
        public function ArgumentErrorExample() {
                println("Hello World");
                
                try {
                    this["println"]("Hello", "World");
                }
                catch(e:ArgumentError) {
                    trace(e);
                }
        }
        
        public function println(str:String):void {
            trace(str);
        }
    }
}