Arbeiten mit INI Files in VBScript

Verwendung:   Lädt eine INI-Datei in das Objekt.

Parameter:    strFilePath (String)  - Der Pfad zur Datei
              intEncoding (Integer) - Kennung für die Zeichencodierung, in der die
                                      Datei gespeichert ist. Mögliche Werte sind:
                                        * -2 = System default
                                        * -1 = Unicode (UTF-16)
                                        *  0 = ANSI

Rückgabewert: True bei Erfolg, False wenn die Datei nicht existiert.

Verwendung:   Speichert die durch das Objekt modellierte INI-Datei auf der Festplatte.

Parameter:    strFilePath (String)  -  Der Pfad zur Datei
              intEncoding (Integer) -  Kennung für die Zeichencodierung, in der die
                                       Datei gespeichert werden soll. Mögliche Werte sind:
                                         * -2 = System default
                                         * -1 = Unicode (UTF-16)
                                         *  0 = ANSI
              bolOverwrite (Boolean) - Gibt an, ob eine evtl. unter dem gleichen Namen
                                       existierende Datei überschrieben werden soll
                                       (True) oder nicht (False)

Rückgabewert: True bei Erfolg, False wenn die Datei existiert und der Parameter
              bolOverwrite den Wert False hat (Überschreiben nicht erlaubt).

Verwendung:   Prüft, ob in der INI-Datei eine bestimmte Section existiert.

Parameter:    strSection (String) - Name der Section

Rückgabewert: True falls die Section existiert, False wenn nicht.

Verwendung:   Fügt der INI-Datei eine leere Section hinzu (ohne Key/Value-Pärchen).

Parameter:    strSection (String) - Name der Section

Rückgabewert: True falls die Section angelegt werden konnte, False wenn die Section bereits
              existierte.

Verwendung:   Löscht eine komplette Section incl. Key/Value-Pärchen

Parameter:    strSection (String) - Name der Section

Rückgabewert: True falls die Section gelöscht werden konnte, False wenn die Section nicht
              existierte.

Verwendung:   Löscht alle Key/Value-Pärchen einer Section.

Parameter:    strSection (String) - Name der Section

Rückgabewert: True falls die Key/Value-Pärchen gelöscht werden konnten, False wenn die
              Section nicht existierte.

Verwendung:   Prüft, ob in einer bestimmten Section ein bestimmter Schlüssel existiert.

Parameter:    strSection (String) - Name der Section
              strKey (String)     - Name des Schlüssels

Rückgabewert: True falls die Section und in ihr der Schlüssel existieren, False wenn
              eine dieser Bedingungen nicht zutrifft.

Verwendung:   Fügt einer bestimmten Section einen Schlüssel mit zugehörigem Wert hinzu.

Parameter:    strSection (String) - Name der Section
              strKey (String)     - Name des Schlüssels
              strValue (String)   - Wert des Schlüssels

Rückgabewert: True falls der Schlüssel nach der Zuweisung existiert und den angegebenen
              Wert hat, False wenn nicht.

Verwendung:   Löscht in einer bestimmten Section einen bestimmten Schlüssel.

Parameter:    strSection (String) - Name der Section
              strKey (String)     - Name des Schlüssels

Rückgabewert: True falls der Schlüssel gelöscht werden konnte, False wenn die Section
              und/oder der Schlüssel nicht existierten.

Verwendung:   Löscht in einer bestimmten Section den Wert eine bestimmten Schlüssels.

Parameter:    strSection (String) - Name der Section
              strKey (String)     - Name des Schlüssels

Rückgabewert: True falls der Wert des Schlüssels gelöscht werden konnte, False wenn die
              Section und/oder der Schlüssel nicht existieren.

Verwendung: Alle Sections einer INI-Datei ermitteln.

Parameter:  keine

Ergebnis:   Ein Array mit Strings, das die Namen aller Sections enthält.

Beispiel:   arrSections = objIniFile.Sections

Verwendung: Alle Schlüssel einer bestimmten Section ermitteln.

Parameter:  strSection (String) - Name der Section

Ergebnis:   Ein Array mit Strings, das die Namen aller Schlüssel der
            Section enthält.

Beispiel:   arrKeys = objIniFile.Keys("Section1")

Verwendung: Auslesen/Setzen des Wertes eines Schlüssel in einer bestimmten
            Section.

Parameter:  strSection (String) - Name der Section
            strKey (String)     - Name des Schlüssels

Ergebnis:   Liefert beim Lesezugriff den Wert des Schlüssels als String.

Beispiel:   Lesen:      strValue = objIniFile.Value("Section1", "Key1")
            Schreiben:  objIniFile.Value("Section1", "Key1") = strValue

Verwendung: Auslesen/Setzen aller Key/Value-Pärchen einer bestimmten Section (Bulk Read/Insert).

Parameter:  strSection (String) - Name der Section

Ergebnis:   Liefert beim Lesezugriff ein 2-dimensionales Array. Die erste Dimension
            hat so viele Elemente wie es Key/Value-Pärchen in der Section gibt, die
            zweite Dimension hat zwei Elemente:
              * Index 0 enthält den Namen des Schlüssels
              * Index 1 enthält den Wert des Schlüssels

Beispiel:   Lesen:      arrKeyValues = objIniFile.KeyValues("Section1")
                        WScript.Echo "Wert von Schlüssel " & arrKeyValues(0,0) & ": " & arrKeyValues(0,1)

            Schreiben:  * Methode 1 (natives VBScript-Array)
                            Dim arrKeyValues(2,1)

                            arrKeyValues(0,0) = "Key11" : arrKeyValues(0,1) = "Value11"
                            arrKeyValues(1,0) = "Key12" : arrKeyValues(1,1) = "Value12"
                            arrKeyValues(2,0) = "Key13" : arrKeyValues(2,1) = "Value13"

                            objIniFile.KeyValues("Section1") = arrKeyValues

                        * Methode 2 (manuell erstelltes Array aus Arrays)
                            objIniFile.KeyValues("Section1") = Array(Array("Key11", "Value11"), _
                                                                     Array("Key12", "Value12"), _
                                                                     Array("Key13", "Value13")  _
                                                                    )

Class clsIniFile
  Private objFSO
  Private dicIniFile


  Private Sub Class_Initialize()
    Set objFSO = CreateObject("Scripting.FileSystemObject")  

    Set dicIniFile         = CreateObject("Scripting.Dictionary")  
    dicIniFile.CompareMode = vbTextCompare 
  End Sub


  Private Sub Class_Terminate()
    Clear
    Set objFSO     = Nothing
    Set dicIniFile = Nothing
  End Sub
  
  
  Private Sub Clear
    dicIniFile.RemoveAll
  End Sub
  
  
  Private Function IsArrayDimed(ByRef arrArray, intDimension)
    Dim intUBound
    
    If Not IsArray(arrArray) Or intDimension < 1 Then
      IsArrayDimed = False
      Exit Function
    End If
    
    On Error Resume Next

    intUBound = UBound(arrArray, intDimension)
    IsArrayDimed = (Err.Number = 0)

    On Error Goto 0
  End Function
  
  
  Public Function LoadFile(strFilePath, intEncoding)
    Dim objInStream
    Dim objRegEx, colMatches
    Dim strLine, strSection, strKey, strValue
    Dim dicSection

    Clear
    
    strFilePath = objFSO.GetAbsolutePathName(strFilePath)

    If Not objFSO.FileExists(strFilePath) Then
      LoadFile = False
      Exit Function
    End If
    
    Set objRegEx        = New RegExp
    objRegEx.Global     = False
    objRegEx.IgnoreCase = True

    Set objInStream = objFSO.OpenTextFile(strFilePath, 1, False, intEncoding)

    Do While Not objInStream.AtEndOfStream
      strLine = objInStream.ReadLine
      
      objRegEx.Pattern = "^\[(.+)\]$"  
      Set colMatches   = objRegEx.Execute(strLine)

      If colMatches.Count > 0 Then
        strSection = colMatches(0).SubMatches(0)
        Call AddSection(strSection)
      ElseIf strSection <> "" Then  
        objRegEx.Pattern = "^([^;]+)=(.*)$"  
        Set colMatches   = objRegEx.Execute(strLine)
          
        If colMatches.Count > 0 Then
          strKey   = colMatches(0).SubMatches(0)
          strValue = colMatches(0).SubMatches(1)
          Call AddKeyValue(strSection, strKey, strValue)
        End If
      End If
    Loop

    objInStream.Close
    
    LoadFile = True
  End Function
  
  
  Public Function SaveFile(strFilePath, intEncoding, bolOverwrite)
    Dim objOutStream
    Dim strSection, strKey
    
    strFilePath = objFSO.GetAbsolutePathName(strFilePath)

    If objFSO.FileExists(strFilePath) And Not bolOverwrite Then
      SaveFile = False
      Exit Function
    End If
    
    Set objOutStream = objFSO.OpenTextFile(strFilePath, 2, True, intEncoding)
    
    For Each strSection In Sections
      Call objOutStream.WriteLine("[" & strSection & "]")  

      For Each strKey In Keys(strSection)
        Call objOutStream.WriteLine(strKey & "=" & Value(strSection, strKey))  
      Next
    Next
    
    objOutStream.Close

    SaveFile = True
  End Function

  
  Public Function SectionExists(strSection)
    SectionExists = dicIniFile.Exists(strSection)
  End Function


  Public Function AddSection(strSection)
    Dim dicSection
    
    If Not dicIniFile.Exists(strSection) Then
      Set dicSection         = CreateObject("Scripting.Dictionary")  
      dicSection.CompareMode = vbTextCompare 
      
      Call dicIniFile.Add(strSection, dicSection)
      AddSection = True
    Else
      AddSection = False
    End If
  End Function


  Public Function DeleteSection(strSection)
    If dicIniFile.Exists(strSection) Then
      Call dicIniFile.Remove(strSection)
      DeleteSection = True
    Else
      DeleteSection = False
    End If
  End Function


  Public Function ClearSection(strSection)
    Dim dicSection

    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)
      dicSection.RemoveAll
      ClearSection = True
    Else
      ClearSection = False
    End If
  End Function


  Public Function KeyExists(strSection, strKey)
    Dim dicSection

    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)
      KeyExists = dicSection.Exists(strKey)
    Else
      KeyExists = False
    End If
  End Function


  Public Function AddKeyValue(strSection, strKey, strValue)
    Value(strSection, strKey) = strValue
    AddKeyValue = (Value(strSection, strKey) = strValue)
  End Function


  Public Function DeleteKey(strSection, strKey)
    Dim dicSection

    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)

      If dicSection.Exists(strKey) Then
        Call dicSection.Remove(strKey)
        DeleteKey = True
      Else
        DeleteKey = False
      End If
    Else
      DeleteKey = False
    End If
  End Function


  Public Function ClearKey(strSection, strKey)
    Dim dicSection

    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)

      If dicSection.Exists(strKey) Then
        dicSection.Item(strKey) = ""  
        ClearKey = True
      Else
        ClearKey = False
      End If
    Else
      ClearKey = False
    End If
  End Function


  Public Property Get Sections
    Sections = dicIniFile.Keys
  End Property
  
  
  Public Property Get Keys(ByRef strSection)
    Dim dicSection
    
    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)
      Keys = dicSection.Keys
    Else
      Keys = Array()
    End If
  End Property
  
  
  Public Property Get Value(ByRef strSection, ByRef strKey)
    Dim dicSection

    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)

      If dicSection.Exists(strKey) Then
        Value = dicSection.Item(strKey)
      Else
        Value = ""  
      End If
    Else
      Value = ""  
    End If
  End Property


  Public Property Let Value(ByRef strSection, ByRef strKey, ByRef strValue)
    Dim dicSection

    Call AddSection(strSection)

    Set dicSection = dicIniFile.Item(strSection)

    If Not dicSection.Exists(strKey) Then
      Call dicSection.Add(strKey, strValue)
    Else
      dicSection.Item(strKey) = strValue
    End If
  End Property


  Public Property Get KeyValues(ByRef strSection)
    Dim dicSection, strKey, intIdx, arrResult

    If dicIniFile.Exists(strSection) Then
      Set dicSection = dicIniFile.Item(strSection)

      If dicSection.Count > 0 Then
        ReDim arrResult(dicSection.Count - 1, 1)
        intIdx = 0

        For Each strKey In dicSection.Keys
          arrResult(intIdx, 0) = strKey
          arrResult(intIdx, 1) = dicSection.Item(strKey)
          intIdx = intIdx + 1
        Next
      Else
        arrResult = Array()
      End If
    Else
      arrResult = Array()
    End If
    
    KeyValues = arrResult
  End Property
  
  
  Public Property Let KeyValues(ByRef strSection, ByRef arrKeyValues)
    Dim dicSection
    Dim intArrLength, intCnt

    If Not IsArrayDimed(arrKeyValues, 1) Then Exit Property
    If UBound(arrKeyValues, 1) < 0 Then Exit Property
    
    If Not IsArrayDimed(arrKeyValues, 2) Then
      If Not IsArrayDimed(arrKeyValues(0), 1) Then Exit Property
      If UBound(arrKeyValues(0), 1) < 1 Then Exit Property
    Else
      If UBound(arrKeyValues, 2) < 1 Then Exit Property
    End If

    Call AddSection(strSection)

    Set dicSection = dicIniFile.Item(strSection)

    If Not IsArrayDimed(arrKeyValues, 2) Then
      'Manuell erzeugtes 2-dimensionales Array  
      For intCnt = 0 To UBound(arrKeyValues)
        Value(strSection, arrKeyValues(intCnt)(0)) = arrKeyValues(intCnt)(1)
      Next
    Else
      'Natives 2-dimensionales VBScript Array  
      For intCnt = 0 To UBound(arrKeyValues)
        Value(strSection, arrKeyValues(intCnt, 0)) = arrKeyValues(intCnt, 1)
      Next
    End If
  End Property
End Class

'Alle Variablen müssen vor der ersten Verwendung mit Dim deklariert werden  
Option Explicit


'Konstanten für die Dateisystem-Routinen  
Const ForReading      = 1
Const ForWriting      = 2
Const ForAppending    = 8

Const AsSystemDefault = -2
Const AsUnicode       = -1
Const AsAnsi          = 0


'Die IniFile-Klasse in das Script einbinden  
Include ".\ClassIniFile.vbs"  


'Variablendeklaration  
Dim strIniFilePath, objIniFile
Dim strSection, strKey

'Initialisierung  
strIniFilePath = ".\Test.ini"  
Set objIniFile = New clsIniFile


'============================================  
' Ini-Datei neu anlegen  
'============================================  

'Möglichkeit 1 zum Speichern von Key/Value Pärchen  
objIniFile.AddKeyValue "Section1", "Key11", "Value11"  
objIniFile.AddKeyValue "Section1", "Key12", "Value12"  

'Möglichkeit 2 zum Speichern von Key/Value Pärchen  
objIniFile.Value("Section2", "Key21") = "Value21"  
objIniFile.Value("Section2", "Key22") = "Value22"  

'INI-Datei speichern  
objIniFile.SaveFile strIniFilePath, AsAnsi, True



'============================================  
' INI-Datei ändern  
'============================================  

'INI-Datei einlesen  
objIniFile.LoadFile strIniFilePath, AsAnsi

'Bestehenden Schlüssel ändern  
objIniFile.Value("Section2", "Key22") = "Value22_neu"  

'Neuen Schlüssel hinzufügen  
objIniFile.Value("Section1", "Key13") = "Value13"  

'Wert eines bestehenden Schlüssels löschen, Methode 1  
objIniFile.Value("Section1", "Key11") = ""  

'Wert eines bestehenden Schlüssels löschen, Methode 2  
objIniFile.ClearKey "Section1", "Key12"  

'Bestehenden Schlüssel löschen  
objIniFile.DeleteKey "Section2", "Key21"  

'Neue Section hinzufügen  
objIniFile.AddSection "Section3"  

'Zu bestehender Section gleichzeitig mehrere Values hinzufügen  
'Methode 1: Manuell erzeugtes 2-dimensionales Array (Array of Arrays)  
objIniFile.KeyValues("Section3") = Array(Array("Key31", "Value31"), _  
                                         Array("Key32", "Value32")  _  
                                        )

'Eine neue Section und gleichzeitig mehrere Values hinzufügen  
'Methode 2: Natives 2-dimensionales VBScript-Array  
Dim arrValues(2,1)

arrValues(0,0) = "Key41"  
arrValues(0,1) = "Value41"  
arrValues(1,0) = "Key42"  
arrValues(1,1) = "Value42"  
arrValues(2,0) = "Key43"  
arrValues(2,1) = "Value43"  

objIniFile.KeyValues("Section4") = arrValues  

'Prüfen ob eine Section existiert  
If objIniFile.SectionExists("Section4") Then  
  WScript.Echo "Section4 existiert"  
  WScript.Echo
Else
  WScript.Echo "Section4 existiert nicht"  
  WScript.Echo
End If

'Prüfen ob in einer Section ein Key existiert und ggf. seinen Value ausgeben  
If objIniFile.KeyExists("Section4", "Key42") Then  
  WScript.Echo "Key42 = " & objIniFile.Value("Section4", "Key42")  
  WScript.Echo
Else
  WScript.Echo "Section4, Key42 existiert nicht"  
  WScript.Echo
End If

'Alle Keys einer Section löschen  
objIniFile.ClearSection "Section4"  

'Prüfen ob in einer Section ein Key existiert und ggf. seinen Value ausgeben  
If objIniFile.KeyExists("Section4", "Key42") Then  
  WScript.Echo "Key42 = " & objIniFile.Value("Section4", "Key42")  
  WScript.Echo
Else
  WScript.Echo "Section4, Key42 existiert nicht"  
  WScript.Echo
End If

'Prüfen ob eine Section existiert  
If objIniFile.SectionExists("Section4") Then  
  WScript.Echo "Section4 existiert"  
  WScript.Echo
Else
  WScript.Echo "Section4 existiert nicht"  
  WScript.Echo
End If

'Komplette Section löschen  
objIniFile.DeleteSection "Section4"  

'Prüfen ob eine Section existiert  
If objIniFile.SectionExists("Section4") Then  
  WScript.Echo "Section4 existiert"  
  WScript.Echo
Else
  WScript.Echo "Section4 existiert nicht"  
  WScript.Echo
End If

'Alle Key/Value-Pärchen einer Section ausgeben  
Dim arrKeyValues, intIdx

arrKeyValues = objIniFile.KeyValues("Section1")  

For intIdx = 0 To UBound(arrKeyValues)
  WScript.Echo arrKeyValues(intIdx, 0) & " = " & arrKeyValues(intIdx, 1)  
Next

WScript.Echo

'INI-Datei speichern  
objIniFile.SaveFile strIniFilePath, AsAnsi, True



'============================================  
' Ini-Datei einlesen und vollständig ausgeben  
'============================================  

WScript.Echo "INI-Datei ausgeben"  
WScript.Echo "------------------"  

'INI-Datei einlesen  
objIniFile.LoadFile strIniFilePath, AsAnsi

'Alle Sections verarbeiten  
For Each strSection In objIniFile.Sections
  'Section ausgeben  
  WScript.Echo "[" & strSection & "]"  

  'Alle Keys der Section verarbeiten  
  For Each strKey In objIniFile.Keys(strSection)
    'Key/Value Pärchen ausgeben  
    WScript.Echo strKey & "=" & objIniFile.Value(strSection, strKey)  
  Next
Next

WScript.Echo



'============================================  
' Routine zum Einbinden von externem Code  
'============================================  

Sub Include(ByRef strFilePath)
  Dim objFSO, objFileStream, strAbsFilePath, strCode

  Set objFSO     = CreateObject("Scripting.FileSystemObject")  
  strAbsFilePath = objFSO.GetAbsolutePathName(strFilePath)

  Set objFileStream = objFSO.OpenTextFile(strAbsFilePath, ForReading, False, AsAnsi)
  strCode           = objFileStream.ReadAll
  objFileStream.Close

  ExecuteGlobal strCode
End Sub