PathFileExistsA function

Determines whether a path to a file system object such as a file or folder is valid.

Syntax

BOOL PathFileExistsA(
  LPCSTR pszPath
);

Parameters

pszPath

Type: LPCTSTR

A pointer to a null-terminated string of maximum length MAX_PATH that contains the full path of the object to verify.

Return Value

Type: BOOL

TRUE if the file exists; otherwise, FALSE. Call GetLastError for extended error information.

Remarks

This function tests the validity of the path.

A path specified by Universal Naming Convention (UNC) is limited to a file only; that is, \server\share\file is permitted. A UNC path to a server or server share is not permitted; that is, \server or \server\share. This function returns FALSE if a mounted remote drive is out of service.

Examples

C++
#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 &lt;&lt; "Search for the file path of : " &lt;&lt; lpStr1 &lt;&lt; endl;
    cout &lt;&lt; "The file requested \"" &lt;&lt; lpStr1 &lt;&lt; "\" is a valid file" &lt;&lt; endl;
    cout &lt;&lt; "The return from function is : " &lt;&lt; retval &lt;&lt; endl;
}

else
{
    cout &lt;&lt; "\nThe file requested " &lt;&lt; lpStr1 &lt;&lt; " is not a valid file" &lt;&lt; endl;
    cout &lt;&lt; "The return from function is : " &lt;&lt; retval &lt;&lt; endl;
}

// Search for the presence of a file with a false result.
retval = PathFileExists(lpStr2);

if(retval == 1)
{
    cout &lt;&lt; "\nThe file requested " &lt;&lt; lpStr2 &lt;&lt; "is a valid file" &lt;&lt; endl;
    cout &lt;&lt; "Search for the file path of : " &lt;&lt; lpStr2 &lt;&lt; endl;
    cout &lt;&lt; "The return from function is : " &lt;&lt; retval &lt;&lt; endl;
}
else
{
    cout &lt;&lt; "\nThe file requested \"" &lt;&lt; lpStr2 &lt;&lt; "\" is not a valid file" &lt;&lt; endl;
    cout &lt;&lt; "The return from function is : " &lt;&lt; retval &lt;&lt; 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

Requirements

   
Windows version Windows 2000 Professional, Windows XP [desktop apps only] Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (version 4.71 or later)