GetFileAttributesA function (fileapi.h)
Retrieves file system attributes for a specified file or directory.
To get more attribute information, use the GetFileAttributesEx function.
To perform this operation as a transacted operation, use the GetFileAttributesTransacted function.
DWORD GetFileAttributesA( [in] LPCSTR lpFileName );
The name of the file or directory.
In the ANSI version of this function, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, call the Unicode version of the function (GetFileAttributesW), and prepend "\\?\" to the path. For more information, see File Names, Paths, and Namespaces.
If the function succeeds, the return value contains the attributes of the specified file or directory. For a list of attribute values and their descriptions, see File Attribute Constants.
If the function fails, the return value is INVALID_FILE_ATTRIBUTES. To get extended error information, call GetLastError.
When GetFileAttributes is called on a directory that is a mounted folder, it returns the file system attributes of the directory, not those of the root directory in the volume that the mounted folder associates with the directory. To obtain the file attributes of the associated volume, call GetVolumeNameForVolumeMountPoint to obtain the name of the associated volume. Then use the resulting name in a call to GetFileAttributes. The results are the attributes of the root directory on the associated volume.
If you call GetFileAttributes for a network share, the function fails, and GetLastError returns ERROR_BAD_NETPATH. You must specify a path to a subfolder on that share.
In Windows 8 and Windows Server 2012, this function is supported by the following technologies.
|Server Message Block (SMB) 3.0 protocol||Yes|
|SMB 3.0 Transparent Failover (TFO)||Yes|
|SMB 3.0 with Scale-out File Shares (SO)||Yes|
|Cluster Shared Volume File System (CsvFS)||Yes|
|Resilient File System (ReFS)||Yes|
Symbolic link behavior—If the path points to a symbolic link, the function returns attributes for the symbolic link.
For an example, see Retrieving and Changing File Attributes.
The fileapi.h header defines GetFileAttributes as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
|Minimum supported client||Windows XP [desktop apps | UWP apps]|
|Minimum supported server||Windows Server 2003 [desktop apps | UWP apps]|
|Header||fileapi.h (include Windows.h)|