ErrObject.Description Property

Reference

Definition

Namespace:: Microsoft.VisualBasic

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Source:: ErrObject.vb

Source:: ErrObject.vb

Source:: ErrObject.vb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };

public string Description { get; set; }

member this.Description : string with get, set

Public Property Description As String

Property Value

String

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

Examples

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)

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 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.

Applies to

Jaa