PathFileExistsA-Funktion (shlwapi.h)

Artikel
11/20/2024

Bestimmt, ob ein Pfad zu einem Dateisystemobjekt wie einer Datei oder einem Ordner gültig ist.

Syntax

BOOL PathFileExistsA(
  [in] LPCSTR pszPath
);

Parameter

[in] pszPath

Typ: LPCTSTR-

Ein Zeiger auf eine null-beendete Zeichenfolge mit maximaler Länge MAX_PATH, die den vollständigen Pfad des zu überprüfenden Objekts enthält.

Rückgabewert

Typ: BOOL-

TRUE, wenn die Datei vorhanden ist; andernfalls FALSE. Rufen Sie GetLastError- für erweiterte Fehlerinformationen auf.

Bemerkungen

Diese Funktion testet die Gültigkeit des Pfads.

Ein durch die Universal Naming Convention (UNC) festgelegter Pfad ist nur auf eine Datei beschränkt. d. h. \server\share\file ist zulässig. Ein UNC-Pfad zu einer Server- oder Serverfreigabe ist nicht zulässig; d. h. \server oder \server\share. Diese Funktion gibt FALSE- zurück, wenn ein bereitgestelltes Remotelaufwerk nicht mehr in Betrieb ist.

Beispiele


#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main(void)
{
    // Valid file path name (file is there).
    char buffer_1[ ] = "C:\\TEST\\file.txt"; 
    char *lpStr1;
    lpStr1 = buffer_1;
    
    // Invalid file path name (file is not there).
    char buffer_2[ ] = "C:\\TEST\\file.doc"; 
    char *lpStr2;
    lpStr2 = buffer_2;
    
    // Return value from "PathFileExists".
    int retval;
    
    // Search for the presence of a file with a true result.
    retval = PathFileExists(lpStr1);
    if(retval == 1)
    {
        cout << "Search for the file path of : " << lpStr1 << endl;
        cout << "The file requested \"" << lpStr1 << "\" is a valid file" << endl;
        cout << "The return from function is : " << retval << endl;
    }
    
    else
    {
        cout << "\nThe file requested " << lpStr1 << " is not a valid file" << endl;
        cout << "The return from function is : " << retval << endl;
    }
    
    // Search for the presence of a file with a false result.
    retval = PathFileExists(lpStr2);
    
    if(retval == 1)
    {
        cout << "\nThe file requested " << lpStr2 << "is a valid file" << endl;
        cout << "Search for the file path of : " << lpStr2 << endl;
        cout << "The return from function is : " << retval << endl;
    }
    else
    {
        cout << "\nThe file requested \"" << lpStr2 << "\" is not a valid file" << endl;
        cout << "The return from function is : " << retval << endl;
    }
}

OUTPUT
==============
Search for the file path of : C:\TEST\file.txt
The file requested "C:\TEST\file.txt" is a valid file
The return from function is : 1

The file requested "C:\TEST\file.doc" is not a valid file
The return from function is : 0

Anmerkung

Der Header "shlwapi.h" definiert PathFileExists 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 2000 Professional, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlwapi.h
Library	Shlwapi.lib
DLL-	Shlwapi.dll (Version 4.71 oder höher)

Freigeben über