【入門編】Word VBAの実行時エラーをログとしてファイルに書き出す：保守性を高めるエラーハンドリングの設計 – Word VBA解析バイブル

Word VBAの実行時エラーをファイルにログ出力！保守性を劇的に高めるエラーハンドリングの設計

Word VBAの世界へようこそ！マクロの記録で「なんとなく動いた」から一歩進んで、自分でコードを書いてみようかな、と思ったあなた。素晴らしい第一歩です！

でも、コードを書き始めると、必ずと言っていいほど遭遇するのが「エラー」ですよね。「実行時エラー 1004」とか「オブジェクトはこのメソッドをサポートしていません」とか、見慣れないメッセージに戸惑った経験、きっとあるはず。

でも、安心してください！エラーは、あなたのコードをより良くするための「ヒント」なんです。そして、そのヒントを効率的に掴み、問題を解決していくための強力な味方が「エラーハンドリング」です。

今回は、Word VBAで発生したエラーをテキストファイルに記録する「デバッグ支援機能」を実装し、あなたのマクロの保守性を劇的に高める方法を、基礎から丁寧に解説していきます。まるで、経験豊富な先輩エンジニアが隣で優しく教えてくれるような感覚で、一緒に学んでいきましょう！

なぜ、エラーハンドリングが重要なのか？

「エラーなんて、発生しないように注意深く書けばいいんじゃない？」と思うかもしれません。確かに、簡単なマクロであれば、それで十分な場合もあります。

しかし、少し複雑な処理になると、予期せぬ事態が発生する可能性はぐっと高まります。例えば：

ユーザーの操作による影響: ユーザーが意図しない操作をしたり、ファイルが見つからなかったり。
Wordの内部的な問題: Word自体の挙動や、アドインとの競合など、開発者側ではコントロールしきれない要因。
コードのバグ: どんなに熟練した開発者でも、うっかりミスはつきものです。

これらのエラーが発生したときに、単に「エラーメッセージが出て処理が中断する」だけでは、原因究明に時間がかかり、ユーザーにも迷惑をかけてしまいます。

そこで登場するのが「エラーハンドリング」です。エラーハンドリングとは、プログラム実行中に発生したエラーを検知し、適切に対処するための仕組みです。これにより、

プログラムの続行: エラーが発生しても、処理を中断させずに続行できる場合があります。
原因の特定: どのエラーが、いつ、どこで発生したのかを記録することで、デバッグが容易になります。
ユーザーへの通知: エラー発生時に、ユーザーに分かりやすいメッセージを表示できます。

特に、あなたが作成したマクロを他の人に使ってもらう場合、エラーハンドリングは「必須」と言っても過言ではありません。

Word VBAにおける「On Error GoTo」の力

Word VBAでエラーハンドリングを行う最も基本的な方法は、`On Error GoTo` ステートメントを使うことです。これは、「もしエラーが発生したら、指定したラベル（場所）にジャンプしなさい」という指示になります。

`On Error GoTo` の基本的な仕組み

Sub Example_OnErrorGoTo()

‘ エラーハンドリングを有効にする
‘ エラーが発生した場合、”ErrorHandler” ラベルにジャンプする
On Error GoTo ErrorHandler

‘ ここに実行したい処理を書く
Dim doc As Document
Set doc = Documents(“存在しないドキュメント.docx”) ‘ ここでエラーが発生する想定

MsgBox “処理は正常に完了しました。”

‘ エラーハンドラをスキップして終了する（正常終了時）
Exit Sub

ErrorHandler:
‘ エラーが発生した場合、ここに処理が移ってくる
MsgBox “エラーが発生しました！”
‘ エラーの詳細を取得し、ログファイルに書き込む処理をここに追加する

End Sub

このコードのポイントは以下の2点です。

1. `On Error GoTo ErrorHandler`: コードの冒頭近くに記述することで、このプロシージャ（Subプロシージャ）内で発生するエラーをすべて捕捉します。エラーが発生すると、コードの実行は `ErrorHandler:` というラベルの付いた行に飛びます。
2. `Exit Sub`: 処理が正常に完了した場合、エラーハンドラに処理が移ってしまうのを防ぐために、`Exit Sub` を記述します。これにより、エラーハンドラをスキップしてプロシージャを終了できます。

陥りやすい落とし穴：エラーハンドラをスキップしない！

もし、`Exit Sub` を忘れてしまうと、たとえエラーが発生しなかったとしても、プロシージャの最後まで実行された後に、エラーハンドラ部分のコードまで実行されてしまいます。 これは意図しない動作を引き起こす可能性があるので、必ず `Exit Sub` を忘れないようにしましょう。

エラーの詳細をログファイルに書き出す！

`On Error GoTo` でエラーを捕捉できるようになったら、次は「どんなエラーだったのか」を記録する仕組みを作りましょう。これには、VBAが提供する組み込み関数 `Err` オブジェクトが役立ちます。

`Err` オブジェクトには、発生したエラーに関する情報が含まれています。

`Err.Number`: エラーコード（数値）
`Err.Description`: エラーの説明（文字列）
`Err.Source`: エラーを発生させたオブジェクトまたはアプリケーション（通常は “VBA Project” など）

これらの情報を、テキストファイルに書き出すことで、後からエラーの原因を調査するのに役立ちます。

ファイル書き出しのコード例

まず、エラー情報を書き込むための共通のプロシージャを作成しておくと便利です。

‘——————————————————————————-
‘ プロシージャ名: WriteErrorLog
‘ 目的: 発生したエラー情報を指定されたファイルに追記する
‘ 引数:
‘ – errNum: エラーコード (Err.Number)
‘ – errDesc: エラーの説明 (Err.Description)
‘ – errSource: エラーソース (Err.Source)
‘ – moduleName: エラーが発生したモジュール名
‘ – procName: エラーが発生したプロシージャ名
‘——————————————————————————-
Sub WriteErrorLog(errNum As Long, errDesc As String, errSource As String, moduleName As String, procName As String)

Dim fs As Object ‘ FileSystemObject
Dim ts As Object ‘ TextStream
Dim logFilePath As String
Dim logEntry As String
Dim currentTime As String

‘ ログファイルのパスを指定（例: ドキュメントフォルダに “WordVBAErrorLog.txt” として保存）
logFilePath = CreateObject(“WScript.Shell”).SpecialFolders(“MyDocuments”) & “\WordVBAErrorLog.txt”

‘ 現在の日時を取得
currentTime = Format(Now, “yyyy/mm/dd hh:nn:ss”)

On Error Resume Next ‘ ファイル書き出し中にエラーが発生しても、処理を中断しないようにする

‘ FileSystemObject を生成
Set fs = CreateObject(“Scripting.FileSystemObject”)

‘ ファイルが存在しない場合は新規作成し、存在する場合は追記モードで開く
‘ 6 は ForAppending 定数（VBA.Enums.FileMode.vbAppend と同等）
Set ts = fs.OpenTextFile(logFilePath, 8, True) ‘ 8 は ForAppending

‘ ログエントリをファイルに書き込む
ts.WriteLine logEntry

‘ TextStream と FileSystemObject を解放
ts.Close
Set ts = Nothing
Set fs = Nothing

On Error GoTo 0 ‘ エラーハンドリングをデフォルトに戻す

End Sub

この `WriteErrorLog` プロシージャは、以下のことを行っています。

ログファイルのパス指定: `CreateObject(“WScript.Shell”).SpecialFolders(“MyDocuments”)` を使うことで、ユーザーの「マイドキュメント」フォルダにログファイルを保存します。これにより、ユーザーごとに異なる環境でも、比較的安全にファイルを保存できます。ファイル名は `WordVBAErrorLog.txt` としました。
現在の日時取得: `Format(Now, “yyyy/mm/dd hh:nn:ss”)` で、いつエラーが発生したのかを正確に記録します。
ログエントリの生成: 日時、モジュール名、プロシージャ名、エラー番号、エラー説明、エラーソースを整形して、1行のログメッセージを作成します。
ファイルへの書き込み: `FileSystemObject` という強力なオブジェクトを使って、指定したファイルにログメッセージを追記します。`OpenTextFile` の第2引数 `8` は「追記モード」を意味します。第3引数 `True` は、「ファイルが存在しない場合は新規作成する」という指示です。
エラーハンドリングの再設定: ファイル書き出し処理内でも `On Error Resume Next` を使っています。これは、万が一ファイル書き出し自体でエラーが発生した場合でも、メインの処理を止めないためです。そして、メインの処理に戻る前に `On Error GoTo 0` でエラーハンドリングをリセットすることを忘れないようにしましょう。

モジュール名とプロシージャ名を取得するには？

`WriteErrorLog` プロシージャに、エラーが発生したモジュール名とプロシージャ名を渡す必要があります。これらは、VBAの組み込み関数 `Erl` や `Debug.Print` ではなく、`Err` オブジェクトから直接取得できるものではありません。

そこで、エラーハンドラ内で、呼び出し元のモジュール名とプロシージャ名を引数として渡すようにします。

実際にエラーハンドリングを組み込んでみよう！

では、先ほどの `On Error GoTo` の例に、`WriteErrorLog` プロシージャを組み込んでみましょう。

‘ — 標準モジュール（例: Module1）に記述 —

‘ ログファイル書き出し用のプロシージャ（上記で定義したもの）
Sub WriteErrorLog(errNum As Long, errDesc As String, errSource As String, moduleName As String, procName As String)
‘ … (WriteErrorLog のコードは省略) …
End Sub

‘——————————————————————————-
‘ プロシージャ名: ProcessDocumentData
‘ 目的: ドキュメントの特定のデータを処理する（エラーハンドリング付き）
‘——————————————————————————-
Sub ProcessDocumentData()

Dim doc As Document
Dim rng As Range
Dim errorOccurred As Boolean ‘ エラー発生フラグ
errorOccurred = False ‘ 初期化

‘ — エラーハンドリングの開始 —
‘ エラーが発生した場合、MyErrorHandler ラベルにジャンプする
On Error GoTo MyErrorHandler

‘ — 処理対象のドキュメントを取得 —
‘ 例: アクティブなドキュメントを取得
Set doc = ActiveDocument

‘ — 処理対象の範囲を取得 —
‘ 例: ドキュメントの最初の段落を取得
Set rng = doc.Paragraphs(1).Range

‘ — ここに具体的な処理を記述 —
‘ 例: 範囲内のテキストを大文字に変換する
rng.Text = UCase(rng.Text)

‘ 正常に処理が完了したことを示すメッセージ（デバッグ用）
Debug.Print “ProcessDocumentData: 処理は正常に完了しました。”

‘ — 正常終了時の処理 —
‘ エラーハンドラにジャンプするのを防ぐために、Exit Sub を記述
GoTo NormalExit

‘ — エラーハンドラ —
MyErrorHandler:
errorOccurred = True ‘ エラー発生フラグを立てる

‘ Err オブジェクトからエラー情報を取得
Dim errNum As Long
Dim errDesc As String
Dim errSource As String

errNum = Err.Number
errDesc = Err.Description
errSource = Err.Source

‘ エラーログを書き込む（モジュール名とプロシージャ名を渡す）
Call WriteErrorLog(errNum, errDesc, errSource, “Module1”, “ProcessDocumentData”) ‘ “Module1” は実際のモジュール名に置き換えてください

‘ ユーザーにエラーが発生したことを通知
MsgBox “処理中にエラーが発生しました。” & vbCrLf & _
“詳細については、ログファイルをご確認ください。” & vbCrLf & _
“(ログファイル: ” & CreateObject(“WScript.Shell”).SpecialFolders(“MyDocuments”) & “\WordVBAErrorLog.txt)”, _
vbCritical, “処理エラー”

‘ エラーオブジェクトをクリア
Err.Clear

‘ — 正常終了時の処理 —
NormalExit:
‘ — オブジェクトの解放 —
‘ エラーが発生しても、正常終了時でも、オブジェクトは解放する
Set rng = Nothing
Set doc = Nothing

‘ エラーハンドリングをデフォルトに戻す
‘ 正常終了時でも、エラーハンドラ部分をスキップするために On Error GoTo 0 を設定する
On Error GoTo 0

End Sub

コードの解説とポイント

`errorOccurred` フラグ: エラーが発生したかどうかを記録するフラグを用意しました。これにより、正常終了時とエラー発生時で、終了時の処理を少し変えることができます（この例では、オブジェクト解放の部分で共通化していますが、より複雑な処理では役立ちます）。
`MyErrorHandler:` ラベル: エラーが発生した場合にジャンプする場所です。
エラー情報の取得: `Err.Number`, `Err.Description`, `Err.Source` からエラーの詳細を取得します。
`Call WriteErrorLog(…)`: 作成した `WriteErrorLog` プロシージャを呼び出し、エラー情報をファイルに書き込みます。ここで、モジュール名とプロシージャ名を正確に指定することが重要です。
ユーザーへの通知: ユーザーにエラーが発生したことを分かりやすく伝え、ログファイルの場所も案内します。
`Err.Clear`: エラーハンドリングが終わったら、`Err.Clear` を呼び出して、エラーオブジェクトをクリアします。これをしないと、次のエラーハンドリングに影響が出る可能性があります。
`GoTo NormalExit`: 正常に処理が完了した場合、エラーハンドラをスキップして `NormalExit` ラベルにジャンプします。
`Set rng = Nothing`, `Set doc = Nothing`: オブジェクト変数は、使い終わったら `Nothing` を代入して解放するのが良い習慣です。これにより、メモリリークを防ぎ、プログラムの安定性を高めます。エラー発生時でも、`NormalExit` ラベルにジャンプする前にオブジェクトが解放されるように配置しています。
`On Error GoTo 0`: プロシージャの最後に `On Error GoTo 0` を記述することで、このプロシージャのエラーハンドリングを無効にします。これにより、このプロシージャから他のプロシージャを呼び出した際に、意図しないエラーハンドリングが連鎖するのを防ぎます。

ログファイルを見てみよう！

もし、上記コードを実行中にエラーが発生した場合、マイドキュメントフォルダに `WordVBAErrorLog.txt` というファイルが作成されているはずです。ファイルを開くと、以下のような内容が記録されています。

このように、エラーが発生した日時、どのモジュール・プロシージャで発生したか、エラーコード、エラーの説明、エラーソースが記録されているため、原因の特定に非常に役立ちます。

さらに高度なエラーハンドリングへ

今回ご紹介した `On Error GoTo` とファイルログ出力は、Word VBAにおけるエラーハンドリングの「基本のキ」です。これをマスターすれば、あなたのマクロは格段に保守しやすくなります。

さらにステップアップしたい方のために、いくつかヒントを。

`On Error Resume Next` の使いどころ: `On Error GoTo` とは異なり、`On Error Resume Next` はエラーが発生しても処理を中断せず、次の行から実行を続行します。これは、特定の行でエラーが発生しても問題ない場合（例: ファイルが存在しなくても処理を続行したい場合など）に限定的に使用するのがおすすめです。多用すると、エラーを見逃してしまう原因になります。
VBA.Enums: ファイルモード（`ForAppending` など）や定数を直接数値で記述するのではなく、`VBA.Enums` を使うことでコードの可読性が向上します。
VB.NET の Exception クラス: もし、将来的に VB.NET など、より高度な開発言語に挑戦する機会があれば、`Try…Catch…Finally` ブロックを使った例外処理を学ぶと、さらに洗練されたエラーハンドリングが可能になります。
ログレベル: エラーの種類（致命的、警告、情報など）に応じてログレベルを分け、ファイルに記録する方式も考えられます。

まとめ

「エラーはバグの元凶」というイメージがあるかもしれませんが、適切にハンドリングすれば、それは「改善のための貴重な情報源」に変わります。

今回学んだ `On Error GoTo` とファイルログ出力は、Word VBA開発において、あなたの強力な武器となるはずです。この知識を活かして、より堅牢で、保守しやすいマクロを作成していってください。

「ここをクリアすれば、Word VBAの基本はバッチリですよ」と、自信を持って言えるようになるはずです。ぜひ、今日からあなたのマクロにエラーハンドリングを組み込んでみてくださいね！