This documentation is archived and is not being maintained.

Description Property

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

For the Err object, returns or sets a descriptive string associated with an error.

Public Property Description() As String

Remarks

The Description property setting consists of a short description of the error. Use this property to alert the user to an error that you can't or don't want to handle. When generating a user-defined error, assign a short description of your error to the Description property. If the Description property isn't 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.

Example

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)

Requirements

Namespace: Microsoft.VisualBasic

Class: ErrObject

Assembly: Microsoft Visual Basic .NET Runtime (in Microsoft.VisualBasic.dll)

See Also

ErrorToString Function | HelpContext Property | HelpFile Property | LastDLLError Property | Number Property | Source Property | Version Property

Applies To

Err Object

Show: