description Property (Windows Scripting - JScript)

 

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

Syntax

object.description [= stringExpression]

Arguments

• object
  Required. Any instance of an Error object.

• stringExpression
  Optional. A string expression containing a description of the error.

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.

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)
}

Requirements

Version 5

Applies To: Error Object (Windows Scripting - JScript)

Change History

Date	History	Reason
March 2009	Modified example and remarks.	Content bug fix.

See Also

number Property (Windows Scripting - JScript)
message Property (Windows Scripting - JScript)
name Property (Windows Scripting - JScript)