Export (0) Print
Expand All

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.

For more detailed information, see the Visual Basic topic Description Property (Err Object).

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)

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft