ErrObject.Description Property

 

Returns or sets a String expression containing a descriptive string associated with an error. Read/write.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public string Description { get; set; }

Property Value

Type: System.String

Returns or sets a String expression containing a descriptive string associated with an error. Read/write.

The Description property setting consists of a short description of the error. Use this property to alert the user to an error that you cannot or do not want to handle. When generating a user-defined error, assign a short description of your error to the Description property. If the Description property is not filled in, and the value of the Number property corresponds to a Visual Basic run-time error, then the string returned by the ErrorToString function is set in the Description property when the error is generated.

This example assigns a user-defined message to the Description property of the Err object.

On Error Resume Next
Err.Raise(60000)
Err.Description = "Your Widget needs a new Frob!"
MsgBox(Err.Description)

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show: