Export (0) Print
Expand All

Information.Err Method

Contains information about run-time errors.

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

public static ErrObject Err()

Return Value

Type: Microsoft.VisualBasic.ErrObject
Contains information about run-time errors.

The properties of the Err object are set by the generator of an error—Visual Basic, an object, or the programmer.

When a run-time error occurs, the properties of the Err object are filled with information that uniquely identifies the error and that you can use to handle the error. To generate a run-time error in your code, use the Raise method.

The Err object's properties are reset to zero or zero-length strings ("") after an Exit Sub, Exit Function, Exit Property, or Resume Next statement within an error-handling routine. Using any form of the Resume statement outside of an error-handling routine will not reset the Err object's properties. You can use the Clear method to explicitly reset Err.

Use the Raise method rather than the Error statement to generate run-time errors for system errors and class modules. Your decision about whether to use the Raise method in other code depends on the richness of the information you want to return.

The Err object is an intrinsic object with global scope. Therefore, you do not need to create an instance of it in your code.

This example uses the properties of the Err object in constructing an error-message dialog box. Notice that if you use the Clear method first, when you 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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft