Share via


Error Object (Windows Scripting - JScript)

 

Contains information about errors.

Syntax

errorObj = new Error()errorObj = new Error([number])errorObj = new Error([number[, description]])

Arguments

  • errorObj
    Required. The variable name to which the Error object is assigned.

  • number
    Optional. Numeric value assigned to an error. Zero if omitted.

  • description
    Optional. Brief string that describes an error. Empty string if omitted.

Remarks

Whenever a run-time error occurs, an instance of the Error object is created to describe the error. This instance has two intrinsic properties that contain the description of the error (description property) and the error number (number property).

An error number is a 32-bit value. The upper 16-bit word is the facility code, while the lower word is the actual error code.

Error objects can also be explicitly created, using the syntax shown above, or thrown using the throw statement. In both cases, you can add any properties you choose to expand the capability of the Error object.

Typically, the local variable that is created in a try...catch statement refers to the implicitly created Error object. As a result, you can use the error number and description in any way you choose.

The following example illustrates the use of the implicitly created Error object.

try
   {
   // Cause an error.
   x = y
   }
catch(e)
   {
   // Prints "[object Error]".
   document.write(e)
   document.write ("<br />");

   // Prints 10.
   document.write ("Facility Code: ")
   document.write(e.number>>16 & 0x1FFF)
   document.write ("<br />");

   // Prints 5009.
   document.write ("Number: ");
   document.write (e.number & 0xFFFF)
   document.write ("<br />");

   // Prints "'y' is undefined".
   document.write ("Description: ")
   document.write (e.description)
   }

Methods

The Error object has no methods.

Properties

description Property | message Property | name Property | number Property

Requirements

Version 5

Change History

Date

History

Reason

March 2009

Modified the example.

Content bug fix.

See Also

new Operator (Windows Scripting - JScript)
throw Statement (Windows Scripting - JScript)
try...catch...finally Statement (Windows Scripting - JScript)
var Statement (Windows Scripting - JScript)