This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

description

Summary

Returns or sets the descriptive string associated with a specific error.

Syntax

object .description  [ =  stringExpression ]
object
Required. Any instance of an Error object.
stringExpression
Optional. A string expression containing a description of the error.

Examples

The following example illustrates the use of the description property.

try
 {
 // Cause an error:
     x = y
 }
 catch(e)
 {
 // Prints "[object Error]":
     document.write(e)
     document.write (" ");
 // Prints 5009:
     document.write((e.number & 0xFFFF))
     document.write (" ");
 // Prints "'y' is undefined":
     document.write(e.description);
     document.write (" ");
 // Prints "'y' is undefined":
     document.write(e.message)
 }

Remarks

The description property contains the error message string associated with a specific error. Use the value contained in this property to alert a user to an error.

The description and message properties provide the same functionality; the description property provides backward compatibility; the message property complies with the ECMA standard.

See also

Other articles

Attributions

  • Microsoft Developer Network: Article