Existiert eine Datei oder ein Ordner?

Einleitung  

In dieser Ausgabe wollen wir verschiedene Möglichkeiten betrachten, mit denen man feststellen kann, ob eine Datei oder ein Ordner auf dem System existiert. Für diesen Zweck existieren in der Funktionsbibliothek von Visual Basic leider keine eigenen Funktionen. Deshalb muss eine Lösung auf anderem Wege gesucht werden. Die vorgestellten Möglichkeiten zur Existenzprüfung dienen nicht dazu, festzustellen, ob auf eine Datei oder einen Ordner zugegriffen werden kann, sondern können lediglich dazu benutzt werden, zu überprüfen, ob eine Datei oder ein Ordner existiert.

Neben den vorgestellten Methoden gibt es noch eine Menge anderer Möglichkeiten. Weitere Informationen zu diesem Thema finden sich im entsprechenden Artikel von Jost Schwider. An dieser Stelle sei Jost Schwider für wichtige Hinweise, die in diesen Artikel Eingang gefunden haben, gedankt. Die Kolumne wurde am 1. November 2005 auf Basis von Kommentaren ergänzt und überarbeitet.

Existenzprüfung mit Visual Basic-eigenen Funktionen  

Folgende Funktion prüft mit Visual Basic-eigenen Mitteln, ob eine Datei oder ein Ordner existiert. Dazu wird die Funktion GetAttr benutzt, die dazu dient, Attribute einer Datei oder eines Ordners zu ermitteln. Wird diese Funktion auf einen nicht existierenden Pfad angewendet, so wird ein Fehler ausgelöst. Durch On Error Resume Next wird unterbunden, dass die Anwendung mit einem Fehler beendet wird.

Private Function FileExists(ByVal FileName As String) As Boolean
    On Error Resume Next
    FileExists = Not CBool(GetAttr(FileName) And (vbDirectory Or vbVolume))
    On Error Goto 0
End Function

Private Function DirExists(ByVal DirectoryName As String) As Boolean
    On Error Resume Next
    DirExists = CBool(GetAttr(DirectoryName) And vbDirectory)
    On Error Goto 0
End Function

Listing 1: Existenzprüfung durch Ermitteln der Attribute mit Visual Basic-eigenen Funktionen

Anstelle von GetAttr im obigen Beispiel könnte auch bspw. die Funktion FileLen oder eine passende andere Dateizugriffsfunktion benutzt werden. Auf die Verwendung der Funktion Dir$ zur Existenzprüfung sollte aber dringend verzichtet werden, da diese Funktion nicht eintrittsinvariant ist. Ihre Verwendung kann zur Folge haben, dass sich anderen Programmteile nach Aufruf der Funktion zur Existenzprüfung nicht mehr wie erwartet verhalten. Im folgenden Beispiel wird in der Prozedur EnumDirs Dir$ zur Aufzählung der Unterordner eines Ordners verwendet. Wird während der Aufzählung eine auf Dir$ basierende Funktion zur Existenzprüfung eingesetzt (im Listing markiert durch ein Rufzeichen), führt dies zu unvollständigen Aufzählungsergebnissen.

Private Sub EnumDirs(ByVal Path As String)
    Dim CurrentDir As String
    CurrentDir = Dir$(Path, vbDirectory)
    Do While Len(CurrentDir) > 0
        If CurrentDir <> "." And CurrentDir <> ".." Then
            If _
                CBool(GetAttr(CombinePath(Path, CurrentDir)) And vbDirectory) _
            Then
                Debug.Print CurrentDir
            End If
        End If
        Debug.Print DirExists("C:\Programme")   ' !
        CurrentDir = Dir$
    Loop
End Sub

Private Function DirExists(ByVal Path As String) As Boolean
    DirExists = (Len(Dir$(Path, vbDirectory)) > 0)
End Function

Private Function CombinePath(ByVal Part1 As String, ByVal Part2 As String)
    CombinePath = Part1
    If Right$(CombinePath, 1) <> "\" Then
        CombinePath = CombinePath & "\"
    End If
    CombinePath = CombinePath & Part2
End Function

Listing 2: Probleme bei Verwendung der Funktion 'Dir$' zur Existenzprüfung

Existenzprüfung mit dem FileSystemObject  

Das FileSystemObject stellt eine Methode mit dem Namen FileExists bereit, die benutzt werden kann, um die Existenz einer Datei zu ermitteln. Analog dazu besitzt das Objekt eine Methode FolderExists zur Existenzbestimmung von Ordnern. Alleine zur Überprüfung der Existenz einer Datei oder eines Ordners ist das FileSystemObject jedoch überdimensioniert und das Hinzufügen der Abhängigkeit zu einem Projekt nicht gerechtfertigt. In Projekten, in denen ohnehin bereits Gebrauch von dieser Komponente gemacht wird, erweist sich diese Methode hingegen als nützlich.

Existenzprüfung mit API-Aufrufen  

Eine einfache Methode zur Existenzüberprüfung von Dateien und Ordnern stellt die Verwendung der API-Funktion GetFileAttributes dar, die ähnlich der Visual Basic-eigenen Funktion GetAttr zum Lesen von Dateiattributen dient. Anders als bei der Funktion GetAttr kann jedoch die Fehlerbehandlung zugunsten der Überprüfung des Rückgabewerts der Funktion eingespart werden.

Private Declare Function GetFileAttributes _
    Lib "kernel32.dll" _
    Alias "GetFileAttributesA" _
( _
    ByVal lpFileName As String _
) As Long

Private Const INVALID_FILE_ATTRIBUTES As Long = -1&

Private Const FILE_ATTRIBUTE_DIRECTORY As Long = &H10&

Private Function FileExists(ByVal FileName As String) As Boolean
    Dim dwAttributes As Long
    dwAttributes = GetFileAttributes(FileName)
    If dwAttributes = INVALID_FILE_ATTRIBUTES Then
        FileExists = False
    ElseIf CBool(dwAttributes And FILE_ATTRIBUTE_DIRECTORY) Then
        FileExists = False
    Else
        FileExists = True
    End If
End Function

Private Function DirExists(ByVal DirectoryName As String) As Boolean
    Dim dwAttributes As Long
    dwAttributes = GetFileAttributes(DirectoryName)
    If dwAttributes = INVALID_FILE_ATTRIBUTES Then
        DirExists = False
    ElseIf CBool(dwAttributes And FILE_ATTRIBUTE_DIRECTORY) Then
        DirExists = True
    Else
        DirExists = False
    End If
End Function

Listing 3: Existenzprüfung durch Ermitteln der Attribute mit API-Aufrufen

Eine weitere Lösung, die auf der Windows-API basiert, macht sich die Funktionen FindFirstFile und FindClose zunutze. Über die erste Funktion erhält man eine Zugriffsnummer auf die erste Datei, deren Name dem übergebenen Muster entspricht. Wenn die Zugriffsnummer gleich -1 ist, dann konnte die Datei nicht gefunden werden. Abschließend wird der Suchvorgang beendet.

Private Declare Function FindFirstFile _
    Lib "kernel32.dll" _
    Alias "FindFirstFileA" _
( _
    ByVal lpFileName As String, _
    ByRef lpFindFileData As WIN32_FIND_DATA _
) As Long
Private Declare Function FindClose Lib "kernel32.dll" ( _
    ByVal hFindFile As Long _
) As Long

Private Const INVALID_HANDLE_VALUE As Long = -1&
Private Const MAX_PATH As Long = 260&

Private Type FILETIME
    dwLowDateTime As Long
    dwHighDateTime As Long
End Type

Private Type WIN32_FIND_DATA
    dwFileAttributes As Long
    ftCreationTime As FILETIME
    ftLastAccessTime As FILETIME
    ftLastWriteTime As FILETIME
    nFileSizeHigh As Long
    nFileSizeLow As Long
    dwReserved0 As Long
    dwReserved1 As Long
    cFileName As String * MAX_PATH
    cAlternate As String * 14
End Type

Private Function FileExists(ByVal FileName As String) As Boolean
    Dim wfd As WIN32_FIND_DATA
    Dim hFile As Long
    hFile = FindFirstFile(FileName, wfd)
    FileExists = (hFile <> INVALID_HANDLE_VALUE)
    If hFile <> INVALID_HANDLE_VALUE Then
        Call FindClose(hFile)
    End If
End Function

Listing 4: Existenzprüfung durch Suche nach dem Dateinamen

Weiters bietet sich die API-Funktion PathFileExists aus der shlwapi.dll an. Ein Beispiel zu deren Verwendung findet sich im Tipp 0605: Path-APIs nutzen. Es ist zu beachten, dass diese Funktion nicht unter allen Versionen von Windows zur Verfügung steht.

Ihre Meinung  

Falls Sie Fragen zu diesem Artikel haben oder Ihre Erfahrung mit anderen Nutzern austauschen möchten, dann teilen Sie uns diese bitte in einem der unten vorhandenen Themen oder über einen neuen Beitrag mit. Hierzu können sie einfach einen Beitrag in einem zum Thema passenden Forum anlegen, welcher automatisch mit dieser Seite verknüpft wird.