ErrObject Class

.NET Framework (current version)

The ErrObject module contains properties and procedures used to identify and handle run-time errors using the Err object.

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

Inheritance Hierarchy

System::Object
Microsoft.VisualBasic::ErrObject

Syntax

C++

public ref class ErrObject sealed

Properties

	Name	Description
	Description	Returns or sets a String expression containing a descriptive string associated with an error. Read/write.
	Erl	Returns an integer indicating the line number of the last executed statement. Read-only.
	HelpContext	Returns or sets an Integer containing the context ID for a topic in a Help file. Read/write.
	HelpFile	Returns or sets a String expression containing the fully qualified path to a Help file. Read/write.
	LastDllError	Returns a system error code produced by a call to a dynamic-link library (DLL). Read-only.
	Number	Returns or sets a numeric value specifying an error. Read/write.
	Source	Returns or sets a String expression specifying the name of the object or application that originally generated the error. Read/write.

Methods

	Name	Description
	Clear()	Clears all property settings of the Err object.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetException()	Returns the exception representing the error that occurred.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Raise(Int32, Object^, Object^, Object^, Object^)	Generates a run-time error; can be used instead of the Error statement.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

The ErrObject module supports the Err object. For more information, see Err.

This example uses the properties of the Err object in constructing an error-message dialog box. Notice what happens when you use the Clear method first: When you then generate a Visual Basic error with the Raise method, Visual Basic's default values become the properties of the Err object.

Dim Msg As String
' If an error occurs, construct an error message.
On Error Resume Next   ' Defer error handling.
Err.Clear
Err.Raise(6)   ' Generate an "Overflow" error.
' Check for error, then show message.
If Err.Number <> 0 Then
    Msg = "Error # " & Str(Err.Number) & " was generated by " _
        & Err.Source & ControlChars.CrLf & Err.Description
    MsgBox(Msg, MsgBoxStyle.Information, "Error")
End If

Version Information

.NET Framework
Available since 1.1
Silverlight
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.