FileSetAttrib

Changes the attributes of one or more files or folders. Wildcards are supported.

FileSetAttrib Attributes , FilePattern, Mode

Parameters

Attributes

Type: String

The attributes to change. For example, "+HA-R".

To easily turn on, turn off or toggle attributes, prefix one or more of the following attribute letters with a plus (+), minus (-) or caret (^) symbol, respectively:

• R = READONLY
• A = ARCHIVE
• S = SYSTEM
• H = HIDDEN
• N = NORMAL (this is valid only when used without any other attributes)
• O = OFFLINE
• T = TEMPORARY

If no symbol precedes the attribute letters, the file's attributes are replaced with the given attributes. See example #5. To remove all attributes, use "N" on its own.

FilePattern

Type: String

If omitted, the current file of the innermost enclosing file loop will be used. Otherwise, specify the name of a single file or folder, or a wildcard pattern such as "C:\Temp\*.tmp". FilePattern is assumed to be in A_WorkingDir if an absolute path isn't specified.

Both asterisks (*) and question marks (?) are supported as wildcards. * matches zero or more characters and ? matches any single character. Usage examples:

• *.* or * matches all files.
• *.htm matches files with the extension .htm, .html, etc.
• *. matches files without an extension.
• log?.txt matches e.g. log1.txt but not log10.txt.
• *report* matches any filename containing the word "report".

Mode

Type: String

If blank or omitted, only files are operated upon and subdirectories are not recursed into. Otherwise, specify one or more of the following letters:

• D = Include directories (folders).
• F = Include files. If both F and D are omitted, files are included but not folders.
• R = Subfolders are recursed into so that files and folders contained therein are operated upon if they match FilePattern. All subfolders will be recursed into, not just those whose names match FilePattern. If R is omitted, files and folders in subfolders are not included.

Error Handling

An Error is thrown if any files failed to be changed, with its Extra property set to the number of failures.

If files were found, A_LastError is set to 0 (zero) or the result of the operating system's GetLastError() function immediately after the last failure. Otherwise A_LastError contains an error code that might indicate why no files were found.

Remarks

The compression state of files cannot be changed with this function.

Related

FileGetAttrib, FileGetTime, FileSetTime, FileGetSize, FileGetVersion, file loop

Examples

FileSetAttrib "+RH", "C:\MyFiles\*.*", "DF"  ; +RH is identical to +R+H

FileSetAttrib "^H", "C:\MyFiles"

FileSetAttrib "-R+A", "C:\New Text File.txt"

FileSetAttrib "+A", "C:\*.ini", "R"

FileSetAttrib(FileGetAttrib(file2), file1)