Errオブジェクトとユーザー定義エラー

最終更新日：2019-11-06

第134回.Errオブジェクトとユーザー定義エラー

VBA実行時には種々のエラーが発生します。
実行時エラーに関する情報は、Errオブジェクトには入っていますので、
VBA実行でエラー発生した場合は、Errオブジェクトを参照しエラー内容を調べることになります。
Errオブジェクトの使い方と、ユーザー定義エラーの生成方法について解説します。

Errオブジェクト

実行時エラーに関する情報はErrオブジェクトに入っています。
VBA実行でエラーが発生すると、Errオブジェクトのプロパティにはエラーに関する情報が設定されます。

Errオブジェクトは、グローバルなスコープの組み込みオブジェクトです。
VBAコード内にそのインスタンスを作成する必要はありません。

Errオブジェクトのメソッド

プロパティ	説明
Clear	Errオブジェクトのプロパティ設定をすべて解除します。
Raise	実行時エラーを生成します。

これらのメソッドについては、後のセクションで詳しく説明します。

Errオブジェクトのプロパティ

メソッド	説明
Description	エラーに関連付けられている説明の文字列を取得または設定します。
HelpContext	ヘルプファイルのトピックに対応するコンテキストIDを含む文字列式を返すか設定します。
HelpFile	ヘルプファイルへの完全修飾パスを含む文字列式を設定または返します。
Number	エラーを示す数値を取得または設定します。 Numberは、Errオブジェクトの既定のプロパティです。
Source	最初にエラーを生成したオブジェクトまたはアプリケーションの名前を指定する文字列式を取得または設定します。

DescriptionとNumber以外は使う事はないでしょう。

VBA実行エラー時のErrオブジェクトの基本的な使い方


  
    
      Cells(0, 0) = 1

このVBAを実行すると、以下のエラーが表示されます。

ここで「デバッグ」をクリックし、イミディエイトウインドウで、

?Err.Number
?Err.Description

エラー発生時に、エラー番号とエラーの説明を見ることができます。

On Errorを使う事で、エラーを捕捉しエラー情報をVBAで使う事が出来ます。


  
    
      On Error Resume Next

      Cells(0, 0) = 1

      Debug.Print Err.Number

      Debug.Print Err.Description

このVBAを実行すると、イミディエイトウインドウに以下が出力されます。

Errオブジェクト既定のNumberプロパティ

Errオブジェクトの既定のプロパティはNumberです。
エラー未発生の状態は0です。
つまり、エラー発生時には0以外の値が設定されています。


  
    
      If Err.Number <> 0 Then

　　MsgBox "エラー"

End If

Numberは既定のプロパティなので省略可能です。


  
    
      If Err <> 0 Then

　　MsgBox "エラー"

End If

さらに論理値の判定は、0がFalseで、0以外はTrue
したがって、エラーかどうかの判定だけであれば、以下の記述で判定が可能です。


  
    
      If Err Then

　　MsgBox "エラー"

End If

Errオブジェクトのエラー情報が解除されるのは

Errオブジェクトのエラー情報は、以下により解除（リセット）されます。

エラー処理ルーチン内のプロシージャーまたはプロパティを抜けた後

On Errorが記述されているプロシージャーが終了するときにErrオブジェクトはリセットされます。
Exit Sub、Exit Function、Exit Propertyの実行後、または、End Sub、End Function、End Propertyの実行後にリセットされます。

On Error Goto 0 が実行されたとき

現在のプロシージャで有効なすべてのエラーハンドラーが無効になり、Errオブジェクトはリセットされます。

On Error Resume Nextが実行されたとき
On Error GoTo ラベルが実行されたとき

新たにエラー処理ルーチンが有効になり、Errオブジェクトはリセットされます。

ErrオブジェクトのClearメソッドが実行されたとき

Errオブジェクトのプロパティ設定をすべて解除します。
現在のプロシージャで有効なエラーハンドラーは引き続き有効です。

Errオブジェクトのエラー情報解除の使用例


  
    
      Sub Clearの使用例()

      　　Dim i As Long

      　　On Error Resume Next

      　　For i = 2 To 10

      　　　　Cells(i, 2) = WorksheetFunction.VLookup(Cells(i, 1), Range("D:F"), 2, 0)

      　　　　If Err.Number <> 0 Then

      　　　　　　Cells(i, 2) = "検索値なし"

      　　　　　　Err.Clear

      　　　　End If

      　　Next

      End Sub

Errオブジェクトのエラー情報は、上述したとき以外はその情報が保持されます。
上記VBAでErr.Cleaがないと、
1度エラーが発生すると、プロシージャーを抜けるまで常にエラー情報が残っています。
つまり、一度でもVlookupの検索値が無い行が存在すると、それ以降は全て"検索値なし"となってしますます。
このVBAは、以下のように、On Error Resume Nextだけで記述することもできます。


  
    
      Sub ResumeNextの使用例()

      　　Dim i As Long

      　　For i = 2 To 10

      　　　　On Error Resume Next

      　　　　Cells(i, 2) = WorksheetFunction.VLookup(Cells(i, 1), Range("D:F"), 2, 0)

      　　　　If Err.Number <> 0 Then

      　　　　　　Cells(i, 2) = "検索値なし"

      　　　　　　Err.Clear

      　　　　End If

      　　Next

      End Sub

Forループの先頭でOn Error Resume Nextしているので、ここでErrオブジェクトがリセットされています。

On Error GoTo の注意点

On Error GoTo は、1度エラー発生した後はエラー処理が無効になります。
したがって、エラー処理ルーチンにおいてエラー発生する可能性がある場合は、
On Error Resume Next を使ってください。


  
    
      Sub GoToの使用例3()

　　Dim i As Long

　　For i = 2 To 10

　　　　On Error GoTo ErrLabel

　　　　Cells(i, 2) = WorksheetFunction.VLookup(Cells(i, 1), Range("D:F"), 2, 0)

　　Next

　　Exit Sub

      ErrLabel:

      　　'エラー情報を使った

      　　On Error Resume Next 'ここでErrオブジェクトはリセットされます

      　　'エラーの可能性がある処理

　　MsgBox "検索値なし"

End Sub

On Error Resume Nextの実行でErrオブジェクトはリセットされてしまいますので、
必要なエラー情報はその前に取得しておく必要があります。
また、上記VBAで、On Error Resume Nextが無い場合、
その後の処理でエラー発生した場合、VBAはエラー停止してしまいます。

On Error GoTo ラベルでループ内に戻るような記述は使用しない


  
    
      Sub sample()

　　Dim i, j

      　　For i = 1 To 100

      L01:

      　　　　On Error GoTo L02

　　　　j = i / 0

L02:

　　　　GoTo L01

　　Next

End Sub

極めて単純化した例になりますが、
一見すると、上記VBAは永久ループしそうに見えますが、このVBAはエラー停止します。
On Error GoTo は、1度エラー発生した後はエラー処理が無効になります。
したがって、2度目のエラーは補足されません。
これをさける方法もあるようですが、このような使い方はしないことです。

Err.Raiseメソッド

ErrオブジェクトのRaiseメソッドは、ユーザー定義エラーとして実行時エラーを生成します。
Err.Raise number, source, description, helpfile, helpcontext

引数	説明
number	必須。エラーの性質を識別する長整数型、0-65535の値を使用します。範囲外の数値を指定した場合はRaiseメソッドがエラーとなります。 0-512 の値はシステムエラー用に予約されています。 513-65535 の値は、ユーザー定義エラー用に使用できます。
source	省略可能。エラーを生成したオブジェクトまたはアプリケーションの名前を示す文字列式です。
description	省略可能。エラーを説明する文字列式です。指定しない場合、Numberの値が調べられ対応するメッセージが使われます。 Numberに対応するVBAエラーがない場合、"アプリケーション定義またはオブジェクト定義のエラーです。"が使用されます。
helpfile	省略可能。このエラーに関するヘルプを確認できるヘルプファイルへの完全修飾パスです。指定しない場合、VBAのヘルプファイルのドライブ、パス、およびファイル名が使用されます。
helpcontext	省略可能。エラーに関するヘルプを提供するhelpfile内のトピックを識別するコンテキスト ID です。省略した場合、Numberプロパティに対応するエラーに応じた、VBAヘルプファイルのコンテキスト ID が使用されます。

Err.Raiseの使用例

以下では、On Errorがない場合に表示されるメッセージを掲載しています。

Descriptionを省略


  
    
      Err.Raise 513

Descriptionが未指定かつNumberに対応するVBAエラーがないので、"アプリケーション定義またはオブジェクト定義のエラーです。"となります。

Descriptionを指定


  
    
      Err.Raise Number:=513, Description:="ユーザー定義エラーです"

指定したNumberが、VBA実行エラーコードにある場合は、そのDescriptionが表示されます。

システム予約のエラー番号を使用


  
    
      Err.Raise 6

システム予約されているエラー番号、かつ、descriptionを省略しているので、
システムで定義されたメッセージになります。

Errorステートメント

エラーの発生をシミュレートします。
Error エラー番号

通常はErr.Raiseを使用する為、このErrorステートメントを使用することはほぼありません。


  
    
      Err.Raise 513


  
    
      Error 513

この2つのVBAは、結果としては同じになります。
Errorステートメントは、Number以外を指定できない為、
使用用途としては、VBAに用意されたエラーをシミュレーション目的で発生させる場合に使う事になります。

Error関数

指定したエラー番号に対応するエラーメッセージを返します。
Error [ (errornumber) ]

errornumber引数は省略可能です。
errornumberを省略した場合は、最後に発生した実行時エラーに対応するメッセージが返されます。

任意の有効なエラー番号を指定できます。
errornumberが有効でない場合(65536以上)はエラーが発生します。
定義されていないerrornumberの場合は、"アプリケーション定義またはオブジェクト定義のエラーです。"が返されます。
実行時エラーが発生していない場合、またはerrornumberが0の場合は、長さ0の文字列("")が返されます。

エラー番号およびエラーメッセージ

マクロVBA実行時に発生するエラーの番号とエラーメッセージおよび簡単な理由と対策については以下を参照してください。

実行時にトラップ可能なエラー番号一覧

マクロVBA実行時に発生するエラーのエラー番号とエラーメッセージおよび簡単な理由と対策の一覧です。以下の表にあるエラーはトラップ（捕捉）できるエラー一覧になります。OnErrorステートメントおよびErrオブジェクトのNumberロパティを使用して、エラーへの対処を行うことができます。

以下は、VBAのシステムエラー番号とメッセージの一覧を簡易的に取得するVBAです。


  
    
      Sub ErrList()

　　Dim i As Long

　　On Error Resume Next

　　For i = 1 To 65535

　　　　Error i

　　　　Cells(i + 1, 1) = i

　　　　Cells(i + 1, 2) = Err.Description

　　Next

End Sub

これを実行すると、アクティブシートの2行目からエラーの一覧が出力されます。
出力された一覧を見ると、

735	一時ファイルに保存できません。
744	検索文字列が見つかりませんでした。
746	置換後の文字列が長すぎます。

このように513以降にも定義済のエラーが存在してるのが見て取れます。
実際にこれらがどのように使われているかは不明です。
また、
VBA実行では、この出力した一覧にないエラーも存在します。


  
    
      Cells(0, 0) = 123

これを実行すると、以下のエラーが表示されます。
このエラーは、VBAにおいてはかなり頻繁に発生するものですが、上記では取得されません。

したがって、
「513-65535 の値は、ユーザー定義エラー用に使用できます。」
となっていますが、実際には、上で紹介したエラー番号は避けたほうが良いでしょう。
ユーザー定義のエラー番号としてシステム予約の番号を使用しても、区別がつかない事以外の不都合はありませんが、一般的には使用しない事をお勧めします。