FileGetAttrib

Reports whether a file or folder is read-only, hidden, etc.

AttributeString := FileGetAttrib(Filename)

Parameters

Filename

Type: String

The name of the target file, which is assumed to be in A_WorkingDir if an absolute path isn't specified. If omitted, the current file of the innermost enclosing File-Loop will be used instead. Unlike FileExist and DirExist, this must be a true filename, not a pattern.

Return Value

Type: String

This function returns the attributes of the file or folder. This string is a subset of RASHNDOCT, where each letter means the following:

If no file or folder is found, an empty string is returned.

Error Handling

An exception is thrown on failure.

A_LastError is set to the result of the operating system's GetLastError() function.

Remarks

On a related note, to retrieve a file's 8.3 short name, follow this example:

Loop Files, "C:\My Documents\Address List.txt"
    ShortPathName := A_LoopFileShortPath  ; Will yield something similar to C:\MYDOCU~1\ADDRES~1.txt

A similar method can be used to get the long name of an 8.3 short name.

Related

FileExist, DirExist, FileSetAttrib, FileGetTime, FileSetTime, FileGetSize, FileGetVersion, File-loop

Examples

#1

OutputVar := FileGetAttrib("C:\New Folder")

#2: Check if a particular attribute (the Hidden attribute) is present in the retrieved string.

if InStr(FileGetAttrib("C:\My File.txt"), "H")
    MsgBox "The file is hidden."