【入門編】【中級】ステンシルファイルを読み取り専用で開き、競合を防ぐ運用設計 – Visio VBA解析バイブル

スポンサーリンク
スポンサーリンク

ファイルロックの恐怖を回避せよ:複数ユーザー環境で戦うための「読み取り専用ステンシル」運用術

こんにちは。Visio VBAの世界へようこそ。

マクロの記録機能を使って、「あ、これ自動化できるかも!」と気づけたあなたは、すでに自動化エンジニアへの第一歩を力強く踏み出しています。そこから一歩進んで、「誰が使っても壊れない、プロフェッショナルな仕組み」を作りたいと考えるようになった今、あなたはエンジニアとしての「設計(Design)」の入り口に立っています。

今日お話しするのは、単なるコードの書き方ではありません。
「複数の人間が同時に同じファイルを使うとき、どうすればシステムを止めずに済むか?」という、実務における極めて重要な「運用設計」のお話です。

特に、共通の図形集(ステンシルファイル)をサーバーに置いて、チーム全員で参照するような環境では、この知識がないと「ファイルがロックされて開けません!」というエラーの嵐に巻き込まれることになります。

ここをクリアすれば、あなたの作るツールは「個人の便利ツール」から「組織のインフラ」へと昇華しますよ。準備はいいですか?

1. なぜ「普通に開く」だけではダメなのか?

多くの初学者が最初に書くコードは、おそらくこのような形です。

' ⚠️ 初学者が陥りがちな、少し危ういコード
Dim stencil As Visio.Document
Set stencil = Application.Documents.Open("C:\Shared\MyStencil.vssx")

この `Documents.Open` メソッド。実はこれ、Visioに対して「このファイルを編集する準備をしてね」というニュアンスを含んでしまうことがあります。

「ファイルロック」という見えない壁

Windowsの世界には「ファイルロック」という仕組みがあります。誰かがファイルを「書き込みモード」で開くと、他の人はそのファイルを書き換えることができなくなり、最悪の場合、開くことすらできなくなります。

もし、あなたの作ったマクロがステンシルを「書き込みモード」で開いてしまったら?

  • 他のユーザーがそのステンシルを使おうとした時にエラーが出る。
  • マクロが途中でエラー落ちした際、Visioの裏側で「編集中」というフラグが残ったままになり、誰も開けなくなる。

これが、現場でエンジニアを悩ませる「ファイル競合」の正体です。

2. 解決策:`OpenEx` メソッドと「読み取り専用」フラグ

プロの設計者は、ファイルを「見るだけ」のときは、明確に「読み取り専用(Read-Only)で開く」と宣言します。そのために使うのが、`OpenEx` メソッドです。

`OpenEx` は、通常の `Open` よりも強力で、細かなオプション(フラグ)を指定できるメソッドです。

魔法の呪文:`visOpenExReadOnly`

このメソッドを使う際、`visOpenExReadOnly` という定数を渡すことで、「このファイルは絶対に編集しません。ただ中身を見たいだけです」とVisioに伝えることができます。これにより、他のユーザーがそのファイルを編集していても、安全に、かつ競合を起こさずに読み込むことが可能になります。

3. 【実践】堅牢なステンシル読み込み関数

それでは、現場でそのまま使えるレベルの、エラーハンドリング(例外処理)を組み込んだコードを見てみましょう。単に開くだけでなく、「ファイルが存在するか?」「開けなかったらどうするか?」までを考慮するのが、設計の肝です。

''' <summary>
''' 指定されたパスのステンシルを【読み取り専用】で安全に開く関数
''' </summary>
''' <param name="filePath">ステンシルファイルのフルパス</param>
''' <returns>開いたDocumentオブジェクト。失敗した場合はNothingを返す</returns>
Function SafeOpenStencilReadOnly(ByVal filePath As String) As Visio.Document
    Dim doc As Visio.Document
    
    ' 1. ファイルの存在チェック(そもそもファイルがないとエラーになるため)
    If Dir(filePath) = "" Then
        MsgBox "エラー: 指定されたファイルが見つかりません。" & vbCrLf & filePath, vbCritical
        Set SafeOpenStencilReadOnly = Nothing
        Exit Function
    End If

    On Error GoTo ErrorHandler

    ' 2. OpenExを使用して、読み取り専用フラグを指定して開く
    ' visOpenExReadOnly: 読み取り専用で開く
    ' visOpenDocOpenEx: OpenExメソッドの標準的な動作指定
    Set doc = Application.Documents.OpenEx(filePath, visOpenExReadOnly)

    ' 成功したらオブジェクトを返す
    Set SafeOpenStencilReadOnly = doc
    Exit Function

ErrorHandler:
    ' 3. エラーが発生した場合の処理
    ' ファイルが別のプロセスで強力にロックされている場合などにここへ飛ぶ
    MsgBox "ステンシルの読み込み中にエラーが発生しました。" & vbCrLf & _
           "エラー番号: " & Err.Number & vbCrLf & _
           "説明: " & Err.Description, vbExclamation
    
    Set SafeOpenStencilReadOnly = Nothing
End Function

''' <summary>
''' メイン処理の例
''' </summary>
Sub MainProcess()
    Dim myStencil As Visio.Document
    Dim stencilPath As String
    
    ' 対象のパス(実際はサーバーパスなど)
    stencilPath = "C:\Templates\CompanyMaster.vssx"
    
    ' 安全にステンシルを読み込む
    Set myStencil = SafeOpenStencilReadOnly(stencilPath)
    
    ' 読み込みに成功したか確認
    If Not myStencil Is Nothing Then
        Debug.Print "ステンシルの読み込みに成功しました: " & myStencil.Name
        
        ' --- ここでマスターシェイプを使った処理を行う ---
        ' 例: myStencil.Masters(1).get_Shapes().Item(1)...
        
        ' 4. 【重要】使い終わったら必ず閉じる
        ' 読み取り専用であっても、メモリ管理とロック解放のために閉じるのが鉄則
        myStencil.Close
        Set myStencil = Nothing
        Debug.Print "ステンシルを安全に閉じました。"
    Else
        Debug.Print "ステンシルの読み込みに失敗したため、処理を中断します。"
    End If
End Sub

4. アーキテクトの視点:オブジェクトのライフサイクルを管理せよ

ここで、一つだけ非常に重要な「設計の心得」を伝えます。それは「オブジェクトのライフサイクル(寿命)」を意識することです。

「開けたら、閉じる」は絶対のルール

コードの中に `myStencil.Close` を入れましたね? これは単なる掃除ではありません。
VBAのプログラムが終了しても、Visioのメモリ上に「開いたままのステンシル」が残ってしまうことがあります。これが積み重なると、Visioの動作が重くなったり、最悪の場合、ファイルが「幽霊のようにロックされたまま」になる原因になります。

「開いた(Open)なら、必ず閉じる(Close)」
この原則を守るだけで、あなたのツールの信頼性は劇的に向上します。

パフォーマンスの重み

もし、ループ処理の中で何度も同じステンシルを開閉しているとしたら、それはパフォーマンスの大きな損失です。

  • 悪い例: 100個の図形を作るたびに、ステンシルを開いて閉じる。
  • 良い例: 最初に一度だけステンシルを開き、100個の図形を作り終えてから、最後に一度だけ閉じる。

この「最小限の回数で、確実に管理する」という考え方が、プロフェッショナルへの道です。

まとめ:ここをクリアすれば、基本はバッチリ!

今日のポイントを振り返りましょう。

1. `Documents.Open` ではなく `OpenEx` を使う。
2. `visOpenExReadOnly` フラグを使い、ファイル競合(ロック)を防ぐ。
3. `Dir` 関数などで事前にファイルの存在を確認し、エラーを未然に防ぐ。
4. 使い終わったら必ず `.Close` でオブジェクトを解放する。

「動けばいい」という段階から、「誰が、いつ、どんな環境で使っても、安全に動き続ける」という段階へ。
この設計思想(マインドセット)を持つことが、世界最高峰のエンジニアへの第一歩です。

一歩ずつ、着実に進んでいきましょう。応援していますよ!

タイトルとURLをコピーしました