On Error ステートメント (Visual Basic)

[アーティクル]
08/09/2011

エラー処理ルーチンを有効にして、プロシージャ内でルーチンの場所を指定します。また、エラー処理ルーチンを無効にする場合にも使用できます。

On Error ステートメントを使用しないと、発生するすべてのランタイムエラーが致命的なエラーになります。つまり、エラーメッセージが表示され、実行が停止します。

可能な場合には、構造化されていない例外処理と On Error ステートメントに頼るよりも、構造化例外処理を使用することをお勧めします。詳細については、「Try...Catch...Finally ステートメント (Visual Basic)」を参照してください。

注意

Error ステートメントでは Error キーワードも使用されます。これは、下位互換性のためにサポートされています。

On Error { GoTo [ line | 0 | -1 ] | Resume Next }

指定項目

語句	定義
GoTo line	必須の line 引数で指定した行から始まるエラー処理ルーチンを有効にします。引数 line には、任意の行ラベルまたは行番号を指定します。ランタイムエラーが発生すると、指定した行に制御が分岐され、エラーハンドラーがアクティブになります。 On Error ステートメントと同じプロシージャ内の行を指定する必要があります。それ以外の行を指定すると、コンパイルエラーが発生します。
GoTo 0	現在のプロシージャで有効になっていたエラーハンドラーを無効にし、Nothing にリセットされます。
GoTo -1	現在のプロシージャで有効になっていた例外を無効にし、Nothing にリセットされます。
Resume Next	ランタイムエラーが発生すると、エラーが発生したステートメントの直後のステートメントに制御が移り、そのステートメントから実行が継続されます。オブジェクトにアクセスするときは、On Error GoTo ではなくこの形式を使用します。

解説

注意

"有効な" エラーハンドラーとは、On Error ステートメントによって有効化されているものを指します。 "アクティブな" エラーハンドラーとは、エラー処理を行っている最中の有効なハンドラーのことを指します。

エラーハンドラーがアクティブな間 (エラーの発生から、Resume、Exit Sub、Exit Function、または Exit Property の各ステートメントまで) にエラーが発生した場合は、現在のプロシージャのエラーハンドラーはエラーを処理できません。制御は呼び出しプロシージャに戻ります。

呼び出しプロシージャに有効なエラーハンドラーがある場合は、そのハンドラーがアクティブになり、エラーを処理します。呼び出しプロシージャのエラーハンドラーもアクティブである場合は、有効であってもアクティブではないエラーハンドラーが見つかるまで、元の呼び出しプロシージャに制御が順次戻されます。有効であってもアクティブではないエラーハンドラーが見つからない場合は、実際にエラーが起こった位置で致命的なエラーが発生します。

エラーハンドラーが呼び出しプロシージャに制御を戻すたびに、そのプロシージャが現在のプロシージャになります。いずれかのプロシージャのエラーハンドラーによってエラーが処理された後は、Resumeステートメントで指定された位置から現在のプロシージャの実行が再開されます。

注意

エラー処理ルーチンは、Sub プロシージャまたは Function プロシージャではありません。行ラベルまたは行番号でマークされたコードのセクションです。

Number プロパティ

エラー処理ルーチンは、Err オブジェクトの Number プロパティの値に基づいて、エラーの原因を判断します。このルーチンでは、他のエラーが発生する前、またはエラーを引き起こす可能性のあるプロシージャが呼び出される前に、Err オブジェクトの関連するプロパティ値をテストまたは保存する必要があります。 Err オブジェクトのプロパティ値には、直前に発生したエラーが反映されます。 Err.Number に関連付けられているエラーメッセージは Err.Description に格納されます。

Throw ステートメント

Err.Raise メソッドによってエラーを発生させたときは、Exception プロパティが Exception クラスの新しいインスタンスに設定されます。派生した例外型の例外を発生させるには、Throw ステートメントを使用します。 Throw ステートメントは、スローする例外インスタンスを指定する 1 つのパラメーターを持っています。これらの機能を既存の例外処理サポートで使用する方法を次に示します。

    On Error GoTo Handler
    Throw New DivideByZeroException()
Handler:
    If (TypeOf Err.GetException() Is DivideByZeroException) Then
    ' Code for handling the error is entered here.
    End If

On Error GoTo ステートメントは、例外クラスに関係なく、すべてのエラーをトラップするという点に注意してください。

On Error Resume Next

On Error Resume Next ステートメントは、ランタイムエラーを発生させたステートメントの直後にあるステートメント、または、On Error Resume Next ステートメントが入っているプロシージャから最後に呼び出しを行ったステートメントの直後のステートメントを使用して、実行を継続させます。これにより、ランタイムエラーが発生しても処理を続けることができます。プロシージャ内の別の場所に制御を移さなくても、エラー処理ルーチンをエラーが発生する可能性がある場所に配置できます。 On Error Resume Next ステートメントは、別のプロシージャが呼び出されると非アクティブになるため、実行時にインラインエラー処理が必要な場合は、呼び出しルーチンごとに On Error Resume Next ステートメントを実行する必要があります。

注意

他のオブジェクトへのアクセス中に生成されたエラーを処理する場合は、On Error GoTo よりも On Error Resume Next 構成要素の方が適しています。オブジェクトと対話した後に毎回 Err を調べれば、そのコードがどのオブジェクトにアクセスしたかが明らかになります。どのオブジェクトが Err.Number にエラーコードを設定したかと、どのオブジェクトが最初にエラーを生成したかについても確認できます (このオブジェクトは Err.Source で指定されます)。

On Error GoTo 0

On Error GoTo 0 は、現在のプロシージャ内のエラー処理を無効にします。このステートメントは、プロシージャに番号 0 の行があったとしても、その行をエラー処理コードの開始位置にするわけではありません。 On Error GoTo 0 ステートメントを指定しなくても、エラーハンドラーはプロシージャが終了すると自動的に無効になります。

On Error GoTo -1

On Error GoTo -1 は、現在のプロシージャ内の例外を無効にします。このステートメントは、プロシージャに番号 -1 の行があったとしても、その行をエラー処理コードの開始位置にするわけではありません。 On Error GoTo -1 ステートメントを指定しなくても、例外はプロシージャが終了すると自動的に無効になります。

エラーが発生しないときにエラー処理コードが実行されないようにするには、次のコード例のように、エラー処理ルーチンの直前に Exit Sub、Exit Function、または Exit Property ステートメントを指定します。

Public Sub InitializeMatrix(ByVal Var1 As Object, ByVal Var2 As Object)
   On Error GoTo ErrorHandler
   ' Insert code that might generate an error here
   Exit Sub
ErrorHandler:
   ' Insert code to handle the error here
   Resume Next
End Sub

この例では、エラー処理コードが Exit Sub ステートメントに続く形で End Sub ステートメントよりも前に置かれ、プロシージャのフローからは分離されています。エラー処理コードは、プロシージャ内の任意の場所に指定できます。

トラップされないエラー

オブジェクトを実行可能ファイルとして実行している場合、オブジェクト内のトラップされないエラーはコントローラーアプリケーションに戻されます。開発環境では、トラップされないエラーがコントローラーアプリケーションに戻されるのは、適切なオプションが設定されている場合だけです。デバッグ時に設定するオプションの説明、そのオプションの設定方法、およびホストがクラスを作成できるかどうかについては、ホストアプリケーションのドキュメントを参照してください。

他のオブジェクトにアクセスするオブジェクトを作成する場合は、アクセス先のオブジェクトが戻す未処理のエラーを処理する必要があります。このオブジェクト内でエラーを処理できない場合は、Err.Number 内のエラーコードをこのオブジェクトの独自のエラーのいずれかに割り当てて、もう 1 レベル上の呼び出し元に渡します。独自のエラーを指定するには、独自のエラーコードを VbObjectError 定数に追加する必要があります。たとえば、独自のエラーコードが 1052 の場合は、次のように割り当てます。

Err.Number = vbObjectError + 1052

ヒント

Windows ダイナミックリンクライブラリ (DLL: Dynamic Link Library) の呼び出し中にシステムエラーが起こった場合は例外が発生しないため、Visual Basic エラートラップではトラップされません。 DLL 関数を呼び出すときは、API の仕様に従ってそれぞれの戻り値を調べ、処理が正しく実行されたかどうかを確認する必要があります。エラーの場合には、Err オブジェクトの LastDLLError プロパティの値を調べます。

使用例

この例では、On Error GoTo ステートメントを使用して、プロシージャ内のエラー処理ルーチンの場所を指定します。ゼロによる除算が行われると、エラー番号 6 が生成されます。このエラーがエラー処理ルーチンで処理された後、エラーが発生したステートメントに制御が戻ります。 On Error GoTo 0 ステートメントはエラートラップを無効にします。その後で、On Error Resume Next ステートメントを使用してエラートラップを遅延させ、次のステートメントによって生成されたエラーのコンテキストが確認できるようにします。 Err.Clear は、エラーを処理した後に Err オブジェクトのプロパティをクリアするために使用されます。

Public Sub OnErrorDemo()
   On Error GoTo ErrorHandler   ' Enable error-handling routine.
   Dim x As Integer = 32
   Dim y As Integer = 0
   Dim z As Integer
   z = x / y   ' Creates a divide by zero error
   On Error GoTo 0   ' Turn off error trapping.
   On Error Resume Next   ' Defer error trapping.
   z = x / y   ' Creates a divide by zero error again
   If Err.Number = 6 Then
      ' Tell user what happened. Then clear the Err object.
      Dim Msg As String
      Msg = "There was an error attempting to divide by zero!"
      MsgBox(Msg, , "Divide by zero error")
      Err.Clear() ' Clear Err object fields.
   End If
Exit Sub      ' Exit to avoid handler.
ErrorHandler:  ' Error-handling routine.
   Select Case Err.Number   ' Evaluate error number.
      Case 6   ' Divide by zero error
         MsgBox("You attempted to divide by zero!")
         ' Insert code to handle this error
      Case Else
         ' Insert code to handle other situations here...
   End Select
   Resume Next  ' Resume execution at same line
                ' that caused the error.
End Sub