Microsoft Visual Basic:

	Error Handling

Introduction to Errors

Overview

Apparently no matter how careful and meticulous you are, there will be problems with your code or your application. Some problems will come from you. Some problems will be caused by users. And some problems will be caused by neither you nor your users. This means that there are things you can fix.

There are things you can avoid as much as possible. And there are things beyond your control. Still, as much as you can, try anticipating any type of problem you imagine may occur when a user is using your application, and take action as much as possible to avoid bad situations.

Error Categories

As mentioned above, there are three main types of problems that you will deal with, directly or indirectly:

Syntax: A syntax error comes from your mistyping a word or forming a bad expression in your code. It could be that you misspelled a keyword such as ByVel instead of ByVal. It could also be a bad expression such as 524+ + 62.55. It could be a "grammar" error such as providing the name of a variable before its data type when declaring a variable (quite common for those who regularly transition from different languages (C/C++, Pascal, C#, Java))

When you use Microsoft Visual Studio to write your code, it would point out the errors while you are writing your code, giving up ample time to fix them. When you compile your application, the compiler can let you know about other syntax errors. For this reason, syntax errors are almost the easiest to fix. Most of the time, the compiler would point out where the problem is so you can fix it
Run-Time: After all syntax errors have been fixed, the program may be ready for the user. There are different types of problems that a user may face when interacting with your program. For example, imagine that, in your code, you indicate that a picture would be loaded and displayed to the user but you forget to ship the picture or the directory of the picture indicated in your code becomes different when a user opens your application. In this case, when you compiled and executed the application in your machine, everything was fine; but when you distribute the application and your user tries to use it, it does not work. This is a type of run-time error
Logic: These are errors that do not fit in any of the above categories. They could be caused by the user misusing your application, a problem with the computer on which the application is running while the same application is working fine in another computer. Because logic errors can be vague, they can also be difficult (even, to the extreme, impossible) to fix

One of the best qualities of an effective programmer is to anticipate as many problems as possible and to deal with them in the early stages. Some problems can be easy to fix. With some others, you will simply need to build more experience to know how to fix them. Unfortunately, it will not be unusual to have users asking you to fix your application when a problem may not come from it.

Classic Error Handling

Introduction

From its early stages, Microsoft Visual Basic has always made it a priority to deal with errors. Most or early errors occur in your code. The Visual Studio IDE can help you detect syntax errors and fix them. In fact, a feature almost unique to the Visual Basic IDE, which is not available in Visual C++ and some versions of Visual C#, is that its Code Editor detects problems immediately as soon as they appear in your code. In fact, in previous versions of Visual Basic and in VBA (Microsoft Access), a message box would display, prompting you to fix the problem. This has always made Visual Basic one of the friendliest programming environments around. When you think everything is fine, compile your code. If there is a syntax error that that the IDE did not signal or that you ignored when writing your code, the compiler will let you know. If there is no syntax error, the compilation will be over and the executable will be ready. You can then execute the application to see the result. If the user is not asked to provide value(s), you are less likely to get a run-time error.

A run-time error is one that occurs when using your application. Consider the following application:

Imports System.Drawing
Imports System.Windows.Forms

Module Exercise

    Public Class Starter
        Inherits Form

        Private LblNumber As Label
        Private TxtNumber As TextBox
        Friend WithEvents BtnCalculate As Button
        Private LblResult As Label
        Private TxtResult As TextBox

        Dim components As System.ComponentModel.Container

        Public Sub New()
            InitializeComponent()
        End Sub

        Public Sub InitializeComponent()
            Text = "Calculations"

            LblNumber = New Label
            LblNumber.Location = New Point(17, 23)
            LblNumber.Text = "Number:"
            LblNumber.AutoSize = True

            TxtNumber = New TextBox
            TxtNumber.Location = New Point(78, 20)
            TxtNumber.Size = New Size(83, 20)

            BtnCalculate = New Button
            BtnCalculate.Location = New Point(78, 45)
            BtnCalculate.Text = "Calculate"
            BtnCalculate.Size = New Size(83, 23)

            LblResult = New Label
            LblResult.Location = New Point(17, 75)
            LblResult.Text = "Result:"
            LblResult.AutoSize = True

            TxtResult = New TextBox
            TxtResult.Location = New Point(76, 72)
            TxtResult.Size = New Size(83, 20)

            Controls.Add(LblNumber)
            Controls.Add(TxtNumber)
            Controls.Add(BtnCalculate)
            Controls.Add(LblResult)
            Controls.Add(TxtResult)

        End Sub

        Private Sub CalculateClicked(ByVal sender As Object, 
                                     ByVal e As EventArgs) 
                                     Handles BtnCalculate.Click
            Dim Number As Double
            Dim Result As Double

            Number = CDbl(TxtNumber.Text)

            Result = Number * 24
            TxtResult.Text = CStr(Result)
        End Sub
    End Class

    Function Main() As Integer

        Dim frmStart As Starter = New Starter

        Application.Run(frmStart)

        Return 0
    End Function

End Module

Here is an example of executing it:

The first aspect you should take into consider is to imagine what could cause a problem. If you think there is such a possibility, start by creating a label that could be used to transfer code if a problem occurs. Here is an example:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        Dim Number As Double
        Dim Result As Double

            Number = CDbl(TxtNumber.Text)

        Result = Number * 24
        TxtResult.Text = CStr(Result)

ThereWasAProblem:
        MsgBox("There was a problem when executing your instructions")
End Sub

If you create such a label, you should tell the compiler when to jump to that label. Otherwise, as in this case, the label section would always execute. Here is an example of running the above version:

In this case, we want the label section to execute only when we want it to. To prevent the compiler from reaching this section if not directed so, you can add an Exit Sub line above the label section:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        Dim Number As Double
        Dim Result As Double

            Number = CDbl(TxtNumber.Text)

        Result = Number * 24
        TxtResult.Text = CStr(Result)

        Exit Sub

ThereWasAProblem:
        MsgBox("There was a problem when executing your instructions")
End Sub

This time if you execute the program with an appropriate value, the label section would not be reached.

In Case Of Error, Jump To Label

The above program will compile fine. When executing it, imagine that the user types an inappropriate value such as 25$.85 instead of 25.85. In this case, the value is not a number, the program would "crash" and let you know that there was a problem:

With some experience, you would know what the problem was, otherwise, you would face a vague explanation. The short story is that the compiler could not continue because, in this case, it could not multiply 25$.85 by another number.

If a problem occurs when a person is using your program, the compiler may display a nasty and insignificant message to the user who would not know what to do with it. Therefore, you can start by creating an appropriate label as introduced above. An error normally occurs in a function. Therefore, to make your code easier to read, you should create a label that shows that it is made for an error instead of being a regular label. The label should also reflect the name of the function. Here is an example:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        Dim Number As Double
        Dim Result As Double

        Number = CDbl(TxtNumber.Text)

        Result = Number * 24
        TxtResult.Text = CStr(Result)

        Exit Sub

BtnOperationClickError:
        MsgBox("The operation could not be executed", 
               MsgBoxStyle.OkOnly, "Operation Error")
End Sub

When you think there will be a problem in your code, somewhere in the lines under the name of the function but before the line that could cause the problem, type On Error GoTo followed by the name of the label that would deal with the error. Here is an example:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        On Error GoTo BtnOperationClickError

        Dim Number As Double
        Dim Result As Double

        Number = CDbl(TxtNumber.Text)

        Result = Number * 24
        TxtResult.Text = CStr(Result)

        Exit Sub

BtnOperationClickError:
        MsgBox("The operation could not be executed", 
               MsgBoxStyle.OkOnly, "Operation Error")
End Sub

Here is an example of running the program:

When the On Error GoTo statement is used, this indicates to the compiler that if any type of error occurs while the code of this function is executed, transfer the compilation to the label. In this case, as soon as something bad happens, the compiler marks the area where the problem occurred, skips the normal code and jumps to the label indicated by the On Error GoTo line. After the section of that label is executed, the compiler returns where the error occurred. If there is nothing to solve the problem, the compiler continues down but without executing the lines of code involved. In this case, it would encounter the Exit Sub line and get out of the function.

In Case Of Error, Jump To Line #

Although the label is more explicit, it only indicates to the compiler what line to jump to in case of a problem. The alternative is to specify a line number instead of a label.

Resume

If a problem occurs in your code and you provide a label to display a friendly message as done above, the compiler would display the message and exit from the function. If this happens, as mentioned above, when the compiler returns where the problem occurred, you can provide an alternative. For example, in our program, if the user provides an inappropriate value that causes the error, you can provide an alternate value and ask the compiler to continue as if nothing happened. In this case, you want to compiler to "resume" its activity.

To indicate that the program should continue, you can use the Resume keyword. Here is an example:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        On Error GoTo BtnOperationClickError

        Dim Number As Double
        Dim Result As Double

        Number = CDbl(TxtNumber.Text)

        Resume

        Result = Number * 24
        TxtResult.Text = CStr(Result)

        Exit Sub

BtnOperationClickError:
        MsgBox("The operation could not be executed", 
               MsgBoxStyle.OkOnly, "Operation Error")
End Sub

When an error occurs, if you want the program to continue with an alternate value than the one that caused the problem, in the label section, type Resume Next. Here is an example:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        On Error GoTo BtnOperationClickError

        Dim Number As Double
        Dim Result As Double

        Number = CDbl(TxtNumber.Text)

        Result = Number * 24
        TxtResult.Text = CStr(Result)

        Exit Sub

BtnOperationClickError:
        MsgBox("The operation could not be executed", 
               MsgBoxStyle.OkOnly, "Operation Error")
        Resume Next
End Sub

In this case, since any numeric variable is initialized with 0, when the compiler returns to the line of code that caused the problem, it would use 0 as a substitute to the inappropriate value. Based on this, you can provide a new value to use in case of error. Here is an example:

Private Sub CalculateClicked(ByVal sender As Object, 
                             ByVal e As EventArgs) 
                             Handles BtnCalculate.Click
        On Error GoTo BtnOperationClickError

        Dim Number As Double
        Dim Result As Double

        Number = CDbl(TxtNumber.Text)

        Result = Number * 24
        TxtResult.Text = CStr(Result)

        Exit Sub

BtnOperationClickError:
        MsgBox("The operation could not be executed", 
               MsgBoxStyle.OkOnly, "Operation Error")

        Number = 10
        Resume Next
End Sub

Here is one example of running the program:

Here is another example of running the same program:

The Err Object

To support error handling, the Visual Basic library provides a global variable named Err. This allows you to identify the error and its description. Because an error depends on what caused it and why, the values of the Err variable also depend and are not always the same.