Simulates the occurrence of an error.
Syntax
Error errornumber
The required errornumber can be any valid error number.
Remarks
The Error statement is supported for backward compatibility. In new code, especially when creating objects, use the Err object's Raise method to generate run-time errors.
If errornumber is defined, the Error statement calls the error handler after the properties of the Err object are assigned the following default values:
| Property | Value |
|---|---|
| Number | Value specified as argument to Error statement. Can be any valid error number. |
| Source | Name of the current Visual Basic project. |
| Description | String expression corresponding to the return value of the Error function for the specified Number, if this string exists. If the string doesn't exist, Description contains a zero-length string (""). |
| HelpFile | The fully qualified drive, path, and file name of the appropriate Visual Basic Help file. |
| HelpContext | The appropriate Visual Basic Help file context ID for the error corresponding to the Number property. |
| LastDLLError | Zero. |
If no error handler exists or if none is enabled, an error message is created and displayed from the Err object properties.
Not all Visual Basic host applications can create objects; for example, hosts running versions of Visual Basic for Applications earlier than 4.0 cannot create objects. Because Err is a function returning an ErrObject instance, it cannot be used in these early versions. To know what version of VBA your host application is running, see the About information for your Visual Basic Editor (VBE), and see your host application's documentation to determine whether it can create classes and objects.
Examples
This example uses the Error statement to simulate error number 11.
On Error Resume Next ' Defer error handling.
Error 11 ' Simulate the "Division by zero" error.