おやじプログラマー日記 : VB.NETでのXMLファイルをINIファイル風に使う方法について

INIファイルは簡単にプログラムの動作パラメータなどを保存しておくには便利な機能です。この機能をXMLファイルで出来る様にクラスを作成してみました。「VB.NETでのINIファイルからのデータ取得・書込について」の記事で作成したINIファイル用クラスにほぼ似せています。

XMLファイルの構造は以下の様になります。

以下にXMLファイルを取り扱うクラスのソースを示します。

Imports System.Xml
Public Class ClsXmlIni
    Private XmlDoc As XmlDocument
    Private XmlFileName As String
    Private XmlNodeIni As XmlNode

''' <summary>
    ''' コンストラクタ
    ''' </summary>
    ''' <param name="strXmlFilePath">XMLファイル</param>
    Public Sub New(ByVal strXmlFilePath As String)
        Try
            '初期XMLファイル読込
            Me.XmlFileName = strXmlFilePath
            Me.XmlDoc = New XmlDocument
            Call Me.XmlDoc.Load(strXmlFilePath)
            Me.XmlNodeIni = Me.XmlDoc.SelectSingleNode("/INI")
        Catch ex As Exception
            Throw ex
        End Try
    End Sub

''' <summary>
    ''' プロファイル文字列の取得
    ''' </summary>
    ''' <param name="strAppName">アプリケーション文字列</param>
    ''' <param name="strKeyName">キー文字列</param>
    ''' <param name="strDefault">デフォルト文字列</param>
    ''' <returns>プロファイル文字列</returns>
    Public Function GetProfileString(ByVal strAppName As String, _
                                     ByVal strKeyName As String, _
                                     ByVal strDefault As String) As String
        '戻り値初期化
        GetProfileString = ""
        Try
            '引数チェック
            If strAppName = "" Or strKeyName = "" Then Exit Function
            'XPathの設定
            Dim strXPath As String = strAppName & "/" & strKeyName
            'XML Nodeの取得
            Dim objXmlNode As XmlNode = Me.XmlNodeIni.SelectSingleNode(strXPath)
            If Not objXmlNode Is Nothing Then
                '値を返す
                GetProfileString = objXmlNode.InnerText
            End If
        Catch ex As Exception
            Throw ex
        End Try
    End Function

''' <summary>
    ''' プロファイル文字列設定
    ''' </summary>
    ''' <param name="strAppName">アプリケーション文字列</param>
    ''' <param name="strKeyName">キー文字列</param>
    ''' <param name="strSet">設定文字列</param>
    ''' <returns>True:正常, False:エラー</returns>
    Public Function WriteProfileString(ByVal strAppName As String, _
                                       ByVal strKeyName As String, _
                                       ByVal strSet As String) As Boolean
        '戻り値初期化
        WriteProfileString = False
        Try
            '引数チェック
            If strAppName = "" Or strKeyName = "" Then Exit Function
            'XPathの設定
            Dim strXPath As String = strAppName & "/" & strKeyName
            'XML Nodeの取得
            Dim objXmlNode As XmlNode = Me.XmlNodeIni.SelectSingleNode(strXPath)
            If Not objXmlNode Is Nothing Then
                '値を設定
                objXmlNode.InnerText = strSet
                'XMLファイルの上書き
                Me.XmlDoc.Save(Me.XmlFileName)
                '正常終了
                WriteProfileString = True
            End If
        Catch ex As Exception
            Return False
        End Try
    End Function
End Class

このクラスを利用する例を以下に記します。尚、このクラスですが各関数でエラーが発生した時には Throw ex で返していますので、呼び出し元では Try...Catch でエラー処理の記述が必要です。
（以下の例ではそれはしていませんが…）
このプログラムを実行すると、XMLファイルは以下の様に変更されます。