【Visio VBA】「既に開かれています」を力技で黙らせるな。ステンシル管理における「堅牢な設計」の極意
業務自動化ツールを開発していると、必ずと言っていいほど直面する壁がある。
Visio VBAにおいて、ステンシル(.vssx)を操作しようとした際に発生する、あの忌々しいエラーだ。
> 「実行時エラー: 指定したドキュメントは既に開かれています」
多くの開発者は、ここで安易な逃げ道を選ぶ。
`On Error Resume Next` を一行書き加え、エラーを握りつぶして無理やり処理を続行させるのだ。
断言しよう。それは「設計」ではなく、単なる「隠蔽」だ。
エラーを無視するコードは、将来的に「どのステンシルが参照されているのか不明」「メモリリークによるVisioの強制終了」「意図しないマスターシェイプの書き換え」といった、修復困難なテクニカルデット(技術的負債)となって君のプロジェクトに襲いかかる。
今日は、プロフェッショナルとして、このエラーを「スマートに回避」し、かつ「極めて堅牢な」ステンシル管理ロジックを実装する方法を伝授する。
1. なぜ「エラーの握りつぶし」が致命的なのか
なぜ `On Error Resume Next` がいけないのか。理由は、オブジェクトのライフサイクル(生存期間)を制御できなくなるからだ。
ステンシルは、Visioの `Documents` コレクションに属する一つの「ドキュメント」である。
もし、既に開いているステンシルがあるにもかかわらず、エラーを無視して新しいインスタンスを作ろうとした場合、プログラムは「今、自分がどのオブジェクトを操作しているのか」の整合性を失う。
- メモリの無駄遣い: 開いていることに気づかず、何度も `Open` を試行する。
- 参照の不一致: 既に開いている古いバージョンのステンシルと、新しく開こうとした最新のステンシルが混在し、シェイプの取得に失敗する。
- デバッグの困難化: 本当に重大なエラー(ファイルが見つからない、権限がない等)が発生しても、すべてが無視されてしまう。
プロのエンジニアは、エラーが起きることを前提にするのではなく、「エラーが起きる状況を事前に検知し、回避するロジック」を設計する。
2. 堅牢な設計思想:Check-Before-Action
スマートな回避策は極めてシンプルだ。
「開こうとする前に、既に `Documents` コレクションの中にそのステンシルが存在するかを確認する」。
この「Check-Before-Action(実行前確認)」の原則に基づき、以下のステップで実装を行う。
1. パスの正規化: 入力されたファイルパスが正しいか、絶対パスとして扱えるかを確認する。
2. 存在確認: `Application.Documents` コレクションをループ、あるいは名前で検索し、対象のステンシルが既にロードされていないか判定する。
3. 条件分岐:
- 存在する場合 $\rightarrow$ その既存オブジェクトをそのまま返す。
- 存在しない場合 $\rightarrow$ 初めて `Open` を実行する。
3. プロダクションレベルのコード実装
以下に、そのまま現場のプロダクションコードとして組み込める、クラスモジュール級の堅牢な関数を示す。単なる関数ではなく、「ステンシルを確実に取得して返す」ことに特化した実装だ。
'' ==========================================================================
'' Module: StencilManager
'' Description: ステンシルの安全な読み込みと管理を行うためのユーティリティ
'' ==========================================================================
Option Explicit
''' <summary>
''' 指定されたパスのステンシルを安全に取得する。
''' 既に開いている場合は既存のものを返し、開いていない場合のみ新規に開く。
''' </summary>
''' <param name="stencilPath">ステンシルのフルパス</param>
''' <returns>Visio.Document オブジェクト (ステンシル)</returns>
''' <exception>ファイルが存在しない場合や、読み込みに失敗した場合はエラーを投げる</exception>
Public Function GetOrCreateStencil(ByVal stencilPath As String) As Visio.Document
Dim doc As Visio.Document
Dim targetName As String
Dim i As Integer
Dim fileExists As Boolean
' 1. パスの妥当性チェック(ファイルが存在するか)
If Dir(stencilPath) = "" Then
Err.Raise vbObjectError + 513, "GetOrCreateStencil", "指定されたステンシルファイルが見つかりません: " & stencilPath
End If
' 2. ファイル名(拡張子含む)のみを抽出して、Documentsコレクション内を検索
' ※ Documents("path/to/file.vssx") では失敗することがあるため、名前での照合が安全
targetName = Mid(stencilPath, InStrRev(stencilPath, "\") + 1)
On Error GoTo ErrorHandler
' 3. 既に開かれているかチェック
For i = 1 To Application.Documents.Count
If Application.Documents(i).Name = targetName Then
' 既に開いている場合は、そのオブジェクトをセットして終了
Set GetOrCreateStencil = Application.Documents(i)
Exit Function
End If
Next i
' 4. 開いていない場合のみ、新規にOpenを実行
' ここでエラーが発生した場合は、ErrorHandlerへ飛ぶ(権限不足、破損など)
Set doc = Application.Documents.Open(stencilPath)
Set GetOrCreateStencil = doc
Exit Function
ErrorHandler:
' エラーの詳細を保持したまま呼び出し元へ投げる
Err.Raise Err.Number, "GetOrCreateStencil", "ステンシルの読み込み中に致命的なエラーが発生しました: " & Err.Description
End Function
''' <summary>
''' テスト用メインルーチン
''' </summary>
Public Sub TestStencilManagement()
Dim myStencil As Visio.Document
Dim targetPath As String
' 本来は設定ファイルやDBから取得すべきパス
targetPath = "C:\Templates\MyCustomStencil.vssx"
On Error GoTo TestErrorHandler
Debug.Print "--- ステンシル取得プロセス開始 ---"
' 【重要】ここでスマートな取得を行う
Set myStencil = GetOrCreateStencil(targetPath)
Debug.Print "成功: " & myStencil.Name & " を使用します。"
' ここにマスターシェイプの操作ロジックを記述する...
' 例: myStencil.Masters(1).get_Shapes(...)
Debug.Print "--- プロセス完了 ---"
Exit Sub
TestErrorHandler:
MsgBox "エラーが発生しました。" & vbCrLf & _
"番号: " & Err.Number & vbCrLf & _
"内容: " & Err.Description, vbCritical, "システムエラー"
End Sub
4. アーキテクトの視点:さらに高みを目指すために
このコードは「動く」レベルを超え、「保守に耐えうる」レベルに引き上げている。しかし、大規模なシステムを設計するなら、以下の3点も念頭に置かなければならない。
① 外部データ(DB/Config)との連携
実務では、ステンシルのパスをコード内にハードコードすることは言語道断だ。
パスは必ず 外部のINIファイル、JSON、あるいはデータベース から取得するように設計せよ。その際、`GetOrCreateStencil` に渡す前に、パスの「末尾のバックスラッシュの有無」や「大文字小文字の揺れ」を正規化する処理を挟むのがプロの仕事だ。
② メモリ管理とクリーンアップ
ステンシルを大量に扱うツールの場合、使い終わったステンシルをいつ `Close` するかも設計の一部だ。
「開きっぱなし」はメモリを食いつぶす。一方で、頻繁な `Open/Close` はパフォーマンスを低下させる。
「アプリケーションのライフサイクル中、一度だけ開いて使い回す(シングルトン・パターンに近い考え方)」 が、Visio自動化における最も効率的な戦略となることが多い。
③ 冪等性(Idempotency)の確保
「何度実行しても、同じ結果が得られ、かつシステムの状態を壊さない」こと。これが自動化ツールの理想だ。
今回紹介した `GetOrCreateStencil` は、既に開いていれば何もしない、開いていなければ開く、という「冪等性」を備えている。この設計思想を、シェイプの生成やプロパティの設定ロジックにも波及させていくのだ。
まとめ
「エラーが出たから無視する」のは、エンジニアの敗北である。
「エラーが起きない構造を作る」ことこそが、我々アーキテクトに課せられた使命だ。
今回学んだ 「事前にコレクションを走査し、存在を確認してからアクションを起こす」 というロジックを、君の武器としてストックしておいてほしい。これが、バグの起きない、信頼される業務ツールを作るための第一歩となる。
