ErrObject Class

 

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)

System.Object
  Microsoft.VisualBasic.ErrObject

public sealed class ErrObject

NameDescription
System_CAPS_pubpropertyDescription

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

System_CAPS_pubpropertyErl

Returns an integer indicating the line number of the last executed statement. Read-only.

System_CAPS_pubpropertyHelpContext

Returns or sets an Integer containing the context ID for a topic in a Help file. Read/write.

System_CAPS_pubpropertyHelpFile

Returns or sets a String expression containing the fully qualified path to a Help file. Read/write.

System_CAPS_pubpropertyLastDllError

Returns a system error code produced by a call to a dynamic-link library (DLL). Read-only.

System_CAPS_pubpropertyNumber

Returns or sets a numeric value specifying an error. Read/write.

System_CAPS_pubpropertySource

Returns or sets a String expression specifying the name of the object or application that originally generated the error. Read/write.

NameDescription
System_CAPS_pubmethodClear()

Clears all property settings of the Err object.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetException()

Returns the exception representing the error that occurred.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodRaise(Int32, Object, Object, Object, Object)

Generates a run-time error; can be used instead of the Error statement.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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

.NET Framework
Available since 1.1
Silverlight
Available since 2.0

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

Return to top
Show: