FindFirstFileA-Funktion (fileapi.h)

Artikel
11/20/2024

Durchsucht ein Verzeichnis nach einer Datei oder einem Unterverzeichnis mit einem Namen, der einem bestimmten Namen entspricht (oder teilweiser Name, wenn Wildcards verwendet werden).

Um zusätzliche Attribute anzugeben, die in einer Suche verwendet werden sollen, verwenden Sie die funktion FindFirstFileEx.

Verwenden Sie die FindFirstFileTransacted-Funktion, um diesen Vorgang als transacted-Vorgang auszuführen.

Syntax

HANDLE FindFirstFileA(
  [in]  LPCSTR             lpFileName,
  [out] LPWIN32_FIND_DATAA lpFindFileData
);

Parameter

[in] lpFileName

Das Verzeichnis oder der Pfad und der Dateiname. Der Dateiname kann Platzhalterzeichen enthalten, z. B. ein Sternchen (*) oder ein Fragezeichen (?).

Dieser Parameter sollte nicht NULL-sein, eine ungültige Zeichenfolge (z. B. eine leere Zeichenfolge oder eine Zeichenfolge, die das endende NULL-Zeichen fehlt) oder in einem nachfolgenden umgekehrten Schrägstrich (\) enden.

Wenn die Zeichenfolge mit einem Wildcard,Punkt (.) oder Verzeichnisnamen endet, muss der Benutzer über Zugriffsberechtigungen für den Stamm und alle Unterverzeichnisse im Pfad verfügen.

Standardmäßig ist der Name auf MAX_PATH Zeichen beschränkt. Um diesen Grenzwert auf 32.767 breite Zeichen zu erweitern, stellen Sie "\\?\" dem Pfad voran. Weitere Informationen finden Sie unter Namensdateien, Pfade und Namespaces.

Trinkgeld

Ab Windows 10, Version 1607, können Sie sich anmelden, um die MAX_PATH Einschränkung zu entfernen, ohne "\\?\". Weitere Informationen finden Sie im Abschnitt "Maximale Pfadlängenbeschränkung" Benennungsdateien, Pfade und Namespaces.

[out] lpFindFileData

Ein Zeiger auf die WIN32_FIND_DATA Struktur, die Informationen zu einer gefundenen Datei oder einem gefundenen Verzeichnis empfängt.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Suchhandle, das in einem nachfolgenden Aufruf von FindNextFile- oder FindClose-verwendet wird, und der lpFindFileData Parameter enthält Informationen zur ersten gefundenen Datei oder dem ersten gefundenen Verzeichnis.

Wenn die Funktion fehlschlägt oder keine Dateien aus der Suchzeichenfolge im parameter lpFileName findet, wird der Rückgabewert INVALID_HANDLE_VALUE und der Inhalt lpFindFileData- unbestimmt. Rufen Sie zum Abrufen erweiterter Fehlerinformationen die GetLastError--Funktion auf.

Wenn die Funktion fehlschlägt, weil keine übereinstimmenden Dateien gefunden werden können, gibt die GetLastError--Funktion ERROR_FILE_NOT_FOUNDzurück.

Bemerkungen

Die FindFirstFile--Funktion öffnet ein Suchhandle und gibt Informationen über die erste Datei zurück, die das Dateisystem mit einem Namen findet, der dem angegebenen Muster entspricht. Dies kann die erste Datei oder das erste Verzeichnis sein, die in einer Verzeichnisauflistungsanwendung (z. B. dem Dir-Befehl) angezeigt wird, wenn dasselbe Dateinamen-Zeichenfolgenmuster angegeben ist. Dies liegt daran, dass FindFirstFile- keine Sortierung der Suchergebnisse durchführt. Weitere Informationen finden Sie unter FindNextFile-.

In der folgenden Liste werden einige andere Suchmerkmale identifiziert:

Die Suche erfolgt streng auf den Namen der Datei, nicht auf Attribute wie ein Datum oder einen Dateityp (weitere Optionen finden Sie unter FindFirstFileEx).
Die Suche enthält die langen und kurzen Dateinamen.
Ein Versuch, eine Suche mit einem nachgestellten umgekehrten Schrägstrich zu öffnen, schlägt immer fehl.
Das Übergeben einer ungültigen Zeichenfolge, NULL-oder einer leeren Zeichenfolge für den parameter lpFileName ist keine gültige Verwendung dieser Funktion. Die Ergebnisse in diesem Fall sind nicht definiert.

Hinweis In seltenen Fällen oder in einem stark geladenen System sind Dateiattributeinformationen auf NTFS-Dateisystemen möglicherweise nicht aktuell, wenn diese Funktion aufgerufen wird. Um sicherzustellen, dass die aktuellen NTFS-Dateisystemattribute abgerufen werden, rufen Sie die GetFileInformationByHandle--Funktion auf.

Nachdem der Suchhandle eingerichtet wurde, können Sie es verwenden, um nach anderen Dateien zu suchen, die mit demselben Muster übereinstimmen, indem Sie die FindNextFile--Funktion verwenden.

Wenn der Suchhandle nicht mehr benötigt wird, schließen Sie es mithilfe der funktion FindClose, nicht CloseHandle.

Wie bereits erwähnt, können Sie keinen nachfolgenden umgekehrten Schrägstrich (\) in der lpFileName Eingabezeichenfolge für FindFirstFile-verwenden. Daher ist es möglicherweise nicht offensichtlich, wie Stammverzeichnisse durchsucht werden. Wenn Sie Dateien anzeigen oder die Attribute eines Stammverzeichnisses abrufen möchten, gelten die folgenden Optionen:

Um Dateien in einem Stammverzeichnis zu untersuchen, können Sie "C:\*" verwenden und das Verzeichnis durchgehen, indem Sie FindNextFile-verwenden.
Verwenden Sie zum Abrufen der Attribute eines Stammverzeichnisses die GetFileAttributes--Funktion.

Hinweis Vor dem Ausstehen der Zeichenfolge "\\?\" keinen Zugriff auf das Stammverzeichnis zulässt.

In Netzwerkfreigaben können Sie eine lpFileName- in Form von "\\Server\Share\*" verwenden. Sie können jedoch keine lpFileName- verwenden, die auf die Freigabe selbst verweist; Beispielsweise ist "\\Server\Share" ungültig.

Um ein Verzeichnis zu untersuchen, das kein Stammverzeichnis ist, verwenden Sie den Pfad zu diesem Verzeichnis, ohne einen nachgestellten umgekehrten Schrägstrich. Beispielsweise gibt ein Argument von "C:\Windows" Informationen zum Verzeichnis "C:\Windows" zurück, nicht über ein Verzeichnis oder eine Datei in "C:\Windows". Um die Dateien und Verzeichnisse in "C:\Windows" zu untersuchen, verwenden Sie einen lpFileName- von "C:\Windows\*".

Beachten Sie, dass ein anderer Thread oder Prozess eine Datei mit diesem Namen zwischen dem Zeitpunkt, zu dem Sie das Ergebnis abfragen, und dem Zeitpunkt, zu dem Sie auf die Informationen reagieren, erstellen oder löschen könnte. Wenn dies ein potenzielles Problem für Ihre Anwendung ist, besteht eine mögliche Lösung darin, die CreateFile--Funktion mit CREATE_NEW zu verwenden (was fehlschlägt, wenn die Datei vorhanden ist) oder OPEN_EXISTING (was fehlschlägt, wenn die Datei nicht vorhanden ist).

Wenn Sie eine 32-Bit-Anwendung schreiben, um alle Dateien in einem Verzeichnis aufzulisten, und die Anwendung kann auf einem 64-Bit-Computer ausgeführt werden, Sie sollten die funktion Wow64DisableWow64FsRedirection aufrufen, bevor Sie FindFirstFile aufrufen und Wow64RevertWow64FsRedirection nach dem letzten Aufruf von FindNextFileaufrufen. Weitere Informationen finden Sie unter Dateisystemumleitung.

Wenn der Pfad auf eine symbolische Verknüpfung zeigt, enthält der WIN32_FIND_DATA Puffer Informationen über die symbolische Verknüpfung, nicht das Ziel.

In Windows 8 und Windows Server 2012 wird diese Funktion von den folgenden Technologien unterstützt.

Technologie	Abgestützt
Server Message Block (SMB) 3.0-Protokoll	Ja
SMB 3.0 Transparent Failover (TFO)	Ja
SMB 3.0 mit Skalierungsdateifreigaben (SO)	Ja
Freigegebenes Clustervolumedateisystem (CsvFS)	Ja
Resilient File System (ReFS)	Ja

Beispiele

Das folgende C++-Beispiel zeigt eine minimale Verwendung von FindFirstFile-.

#include <windows.h>
#include <tchar.h>
#include <stdio.h>

void _tmain(int argc, TCHAR *argv[])
{
   WIN32_FIND_DATA FindFileData;
   HANDLE hFind;

   if( argc != 2 )
   {
      _tprintf(TEXT("Usage: %s [target_file]\n"), argv[0]);
      return;
   }

   _tprintf (TEXT("Target file is %s\n"), argv[1]);
   hFind = FindFirstFile(argv[1], &FindFileData);
   if (hFind == INVALID_HANDLE_VALUE) 
   {
      printf ("FindFirstFile failed (%d)\n", GetLastError());
      return;
   } 
   else 
   {
      _tprintf (TEXT("The first file found is %s\n"), 
                FindFileData.cFileName);
      FindClose(hFind);
   }
}

Ein weiteres Beispiel finden Sie unter Auflisten der Dateien in einem Verzeichnis.

Anmerkung

Der Header fileapi.h definiert FindFirstFile als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows XP [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	fileapi.h (include Windows.h)
Library	Kernel32.lib
DLL-	Kernel32.dll