PackageTop Level
Classpublic dynamic class ArgumentError
InheritanceArgumentError Inheritance Error Inheritance Object

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

View the examples.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties
 PropertyDefined by
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedmessage : String
Contains the message associated with the Error object.
Error
 Inheritedname : String
Contains the name of the Error object.
Error
 Inheritedprototype : 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
 FunctionDefined by
  
ArgumentError(message:String = "")
Creates an ArgumentError object.
ArgumentError
 Inherited
For debugger versions of the Flash Player, only; this method returns the call stack for an error as a string at the time of the error's construction.
Error
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string "Error" by default or the value contained in Error.message, if defined.
Error
 Inherited
Returns the primitive value of the specified object.
Object
Constructor detail
ArgumentError constructor

public function ArgumentError(message:String = "")

Creates an ArgumentError object.

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

The following example shows how an ArgumentError error is generated and handled within a try..catch statement. The following println() function takes one argument, a single string, but two strings are supplied, so the error is thrown. Typcially, the compiler may 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);
        }
    }
}