Error class

Availability

Flash Player 7.

Description

Contains information about an error that occurred in a script. You create an Error object using the Error constructor function. Typically, you "throw" a new Error object from within a try code block that is then "caught" by a catch or finally code block.

You can also create a subclass of the Error class and throw instances of that subclass.

Method summary for the Error class

Method

Description

Error.toString()

Returns the string representation of an Error object.

Property summary for the Error class

Property

Description

Error.message

A string that contains an error message associated with an error.

Error.name

A string that contains the name of the Error object.

Constructor for the Error class

Availability

Flash Player 7.

Usage

new Error([message])

Parameters

message A string associated with the Error object; this parameter is optional.

Returns

Nothing.

Description

Constructor; creates a new Error object. If message is specified, its value is assigned to the object's Error.message property.

Example

In the following example, a function throws an error (with a specified message) if the two strings that are passed to it are not identical.

function compareStrings(string_1, string_2) {
  if(string_1 != string_2) {
    throw new Error("Strings do not match.");
  }
}
try {
  compareStrings("Dog","dog");
} catch (e) {
  trace(e.toString());
}

See also

throw, try..catch..finally