【実務・中級編】【中級】Visioのステンシル検索パスをVBAでレジストリ操作して追加する – Visio VBA解析バイブル

凡庸な自動化を捨て、堅牢なインフラを築け：Visioステンシル検索パスのレジストリ制御術

業務自動化の世界において、「動けばいい」という考え方は、後に必ず致命的な技術負債として牙を剥く。

特に、Visioを用いた大規模な図面作成自動化ツールを開発する場合、避けて通れない壁がある。それは「カスタムステンシルの配布と認識」だ。
開発環境では完璧に動作するツールが、ユーザーの環境にデプロイした途端、「ステンシルが見つかりません」というエラーと共に沈黙する。これは、ステンシルファイル（.vssx）が置かれたディレクトリが、Visioの「検索パス」に含まれていないことが原因だ。

多くのジュニアエンジニアは、ユーザーに「Visioのオプションからパスを手動で追加してください」という、自動化ツールとしては失格な指示を出す。あるいは、VBAから無理やりファイルを直接開こうとして、パスの解決に失敗する。

真のアーキテクトならどうするか？ ユーザーの操作を介さず、アプリケーションの構成要素であるレジストリをプログラムから制御し、環境を「定義」する。

本稿では、Visioのステンシル検索パスをVBAからレジストリ操作によってスマートに追加し、環境依存を排除する、極めて堅牢な実装手法を伝授する。

1. 内部構造の理解：Visioはどこに「記憶」しているのか

まず、設計図を描く前に、対象となるシステムの内部構造を理解せよ。
Visioのステンシル検索パスは、Windowsレジストリの以下の場所に格納されている。

Key: `HKEY_CURRENT_USER\Software\Microsoft\Visio\Configuration`
Value Name: `StencilPaths`
Type: `REG_MULTI_SZ` (複数行文字列)

ここで重要なのは、この値が `REG_MULTI_SZ` であるという点だ。単一の文字列ではなく、改行で区切られたリスト形式として管理されている。
この特性を理解せずに、単純な文字列結合でレジストリを書き換えるような真似をすれば、既存のパスを破壊し、ユーザーのVisio環境を破壊する致命的なバグを生むことになる。

2. 設計原則：冪等性と堅牢性の担保

この機能を実装するにあたり、以下の3つの設計原則を厳守せよ。

1. 冪等性 (Idempotency) の確保: 同じコードを何度実行しても、結果が変わらないこと。既にパスが存在する場合、二重に追加してはならない。
2. 非破壊性: 既存の検索パスを絶対に上書きしてはならない。既存のリストを読み込み、新しいパスを「マージ」するロジックが必要だ。
3. 存在確認の徹底: 追加しようとしているディレクトリが実際に存在するか、事前に検証せよ。存在しないパスを登録するのは、ゴミデータをレジストリに蓄積する行為に他ならない。

3. 実装：プロダクションレベルのコード

以下に、これら全ての原則を満たした、そのまま実務に投入可能なクラスモジュール級のコードを示す。
ここでは、メンテナンス性を考慮し、標準モジュールに実装する形式で記述する。

Option Explicit

' ==============================================================================
' Module: modStencilManager
' Description: Visioのレジストリを操作し、ステンシル検索パスを安全に管理する
' Author: Chief Architect
' ==============================================================================

Private Const REG_KEY As String = "HKEY_CURRENT_USER\Software\Microsoft\Visio\Configuration"
Private Const VALUE_NAME As String = "StencilPaths"

''' <summary>
''' 指定されたディレクトリをVisioのステンシル検索パスに追加する。
''' </summary>
''' <param name="targetPath">追加したいディレクトリのフルパス</param>
''' <returns>成功した場合はTrue、失敗または既に登録済みの場合はFalse</returns>
Public Function AddStencilPathToRegistry(ByVal targetPath As String) As Boolean
    Dim shell As Object
    Dim currentPaths As Variant
    Dim i As Long
    Dim isAlreadyExists As Boolean
    Dim normalizedPath As String
    
    On Error GoTo ErrorHandler
    
    ' 1. パスの正規化（末尾のバックスラッシュを排除し、一貫性を持たせる）
    normalizedPath = NormalizePath(targetPath)
    
    ' 2. ディレクトリの実在確認（存在しないパスを登録するのは悪手）
    If Dir(normalizedPath, vbDirectory) = "" Then
        Debug.Print "Error: Target directory does not exist: " & normalizedPath
        AddStencilPathToRegistry = False
        Exit Function
    End If
    
    ' WScript.Shellオブジェクトの生成（Late Bindingにより参照設定不要）
    Set shell = CreateObject("WScript.Shell")
    
    ' 3. 現状のパスを取得
    ' REG_MULTI_SZは、値が存在しない場合にエラーを投げるため、エラーハンドリングが必要
    On Error Resume Next
    currentPaths = shell.RegRead(REG_KEY & "\" & VALUE_NAME)
    On Error GoTo ErrorHandler
    
    ' 4. 重複チェック（冪等性の確保）
    isAlreadyExists = False
    If IsArray(currentPaths) Then
        For i = LBound(currentPaths) To UBound(currentPaths)
            If NormalizePath(CStr(currentPaths(i))) = normalizedPath Then
                isAlreadyExists = True
                Exit For
            End If
        Next i
    ElseIf Not IsEmpty(currentPaths) Then
        ' 配列ではなく単一文字列として返ってきた場合のケア（稀なケース）
        If NormalizePath(CStr(currentPaths)) = normalizedPath Then isAlreadyExists = True
    End If
    
    If isAlreadyExists Then
        Debug.Print "Info: Path already registered: " & normalizedPath
        AddStencilPathToRegistry = True ' 既に存在するので「成功」として扱う
        Exit Function
    End If
    
    ' 5. 新しいパスリストの構築
    Dim newPaths() As String
    Dim count As Long
    
    ' 現在のパスを配列として再構築
    If IsArray(currentPaths) Then
        ReDim newPaths(0 To UBound(currentPaths) + 1)
        For i = 0 To UBound(currentPaths)
            newPaths(i) = currentPaths(i)
        Next i
        newPaths(UBound(currentPaths) + 1) = normalizedPath
        count = UBound(newPaths)
    ElseIf Not IsEmpty(currentPaths) Then
        ' 単一パスのみ存在する場合
        ReDim newPaths(0 To 1)
        newPaths(0) = currentPaths
        newPaths(1) = normalizedPath
        count = 1
    Else
        ' 現在パスが空の場合
        ReDim newPaths(0 To 0)
        newPaths(0) = normalizedPath
        count = 0
    End If
    
    ' 6. レジストリへの書き込み
    ' RegWriteはREG_MULTI_SZを扱う際、配列を渡すことで適切に処理される
    shell.RegWrite REG_KEY & "\" & VALUE_NAME, newPaths, "REG_MULTI_SZ"
    
    Debug.Print "Success: Added path: " & normalizedPath
    AddStencilPathToRegistry = True
    Exit Function

ErrorHandler:
    Debug.Print "Critical Error in AddStencilPathToRegistry: " & Err.Description
    AddStencilPathToRegistry = False
End Function

''' <summary>
''' パスの末尾のバックスラッシュを削除し、正規化する内部関数
''' </summary>
Private Function NormalizePath(ByVal p As String) As String
    p = Trim(p)
    If Right(p, 1) = "\" And Len(p) > 1 Then
        p = Left(p, Len(p) - 1)
    End If
    NormalizePath = p
End Function

4. 運用の極意：アーキテクトからの警告

このコードをプロダクション環境に投入するにあたり、以下の3点を心得ておけ。

① ライフサイクルの制約

レジストリの書き換えは、Visioの「設定」を書き換える行為だ。しかし、既に起動しているVisioインスタンスは、起動時にレジストリを読み込んでいるため、即座に新しいパスを認識しない。
ツール内でこの処理を行った場合は、「設定を反映させるには、Visioを再起動してください」というメッセージをユーザーに明示的に提示するのが、プロフェッショナルとしての礼儀だ。

② 権限の問題

本コードでは `HKEY_CURRENT_USER` (HKCU) を操作している。これはログイン中のユーザー権限で操作可能な領域であり、管理者権限（UAC）を要求しない。
もし `HKEY_LOCAL_MACHINE` (HKLM) を操作しようとするなら、それは「全ユーザーへの強制適用」を意味するが、同時に管理者権限が必要となり、実行時にエラーで落ちるリスクが高まる。業務ツールとしては、HKCUを操作する設計が最も安全でスマートだ。

③ ユニットテストの実施

レジストリ操作は、一度失敗するとシステムの挙動が不安定になる。
実装後は必ず、
1. パスが存在しない場合にエラーにならないか
2. 既に存在するパスを二重に追加していないか
3. 既存の他のパスが消えていないか
を、手動および自動テストによって徹底的に検証せよ。

結論

自動化エンジニアの価値は、単に「作業を楽にする」ことではなく、「ユーザーがいかに意識することなく、完璧な環境を手に入れられるか」にかかっている。
レジストリを掌握し、環境構築をコードの一部として組み込む。これこそが、プロフェッショナルな業務自動化ツールの真髄である。