FileSystemRights Enumeration
Defines the access rights to use when creating access and audit rules.
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Namespace: System.Security.AccessControlAssembly: mscorlib (in mscorlib.dll)
| Member name | Description | |
|---|---|---|
| ReadData | Specifies the right to open and copy a file or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. | |
| ListDirectory | Specifies the right to read the contents of a directory. | |
| WriteData | Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. | |
| CreateFiles | Specifies the right to create a file. This right requires the Synchronize value. Note that if you do not explicitly set the Synchronize value when creating a file or folder, the Synchronize value will be set automatically for you. | |
| AppendData | Specifies the right to append data to the end of a file. | |
| CreateDirectories | Specifies the right to create a folder. This right requires the Synchronize value. Note that if you do not explicitly set the Synchronize value when creating a file or folder, the Synchronize value will be set automatically for you. | |
| ReadExtendedAttributes | Specifies the right to open and copy extended file system attributes from a folder or file. For example, this value specifies the right to view author and content information. This does not include the right to read data, file system attributes, or access and audit rules. | |
| WriteExtendedAttributes | Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. | |
| ExecuteFile | Specifies the right to run an application file. | |
| Traverse | Specifies the right to list the contents of a folder and to run applications contained within that folder. | |
| DeleteSubdirectoriesAndFiles | Specifies the right to delete a folder and any files contained within that folder. | |
| ReadAttributes | Specifies the right to open and copy file system attributes from a folder or file. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. | |
| WriteAttributes | Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. | |
| Delete | Specifies the right to delete a folder or file. | |
| ReadPermissions | Specifies the right to open and copy access and audit rules from a folder or file. This does not include the right to read data, file system attributes, and extended file system attributes. | |
| ChangePermissions | Specifies the right to change the security and audit rules associated with a file or folder. | |
| TakeOwnership | Specifies the right to change the owner of a folder or file. Note that owners of a resource have full access to that resource. | |
| Synchronize | Specifies whether the application can wait for a file handle to synchronize with the completion of an I/O operation. The Synchronize value is automatically set when allowing access, and automatically excluded when denying access. The right to create a file or folder requires this value. Note that if you do not explicitly set this value when creating a file, the value will be set automatically for you. | |
| FullControl | Specifies the right to exert full control over a folder or file, and to modify access control and audit rules. This value represents the right to do anything with a file and is the combination of all rights in this enumeration. | |
| Read | Specifies the right to open and copy folders or files as read-only. This right includes the ReadData right, ReadExtendedAttributes right, ReadAttributes right, and ReadPermissions right. | |
| ReadAndExecute | Specifies the right to open and copy folders or files as read-only, and to run application files. This right includes the Read right and the ExecuteFile right. | |
| Write | Specifies the right to create folders and files, and to add or remove data from files. This right includes the WriteData right, AppendData right, WriteExtendedAttributes right, and WriteAttributes right. | |
| Modify | Specifies the right to read, write, list folder contents, delete folders and files, and run application files. This right includes the ReadAndExecute right, the Write right, and the Delete right. |
The FileSystemRights enumeration specifies which file system actions are allowed for a particular user account and which file system actions are audited for a particular user account.
Use the FileSystemRights enumeration when creating an access rule with the FileSystemAccessRule class or when creating an audit rule with the FileSystemAuditRule class.
This enumeration contains several granular system rights values and several values that are a combination of those granular values. It is easier to use the combination values such as FullControl, Read, and Write, rather than specifying each component value separately.
The following code example uses the FileSystemRights enumeration to specify an access rule and then remove the access rule from a file. You must supply a valid user or group account to run this example.
Imports System Imports System.IO Imports System.Security.AccessControl Module FileExample Sub Main() Try Dim fileName As String = "test.xml" Console.WriteLine("Adding access control entry for " & fileName) ' Add the access control entry to the file. AddFileSecurity(fileName, "DomainName\AccountName", _ FileSystemRights.ReadData, AccessControlType.Allow) Console.WriteLine("Removing access control entry from " & fileName) ' Remove the access control entry from the file. RemoveFileSecurity(fileName, "DomainName\AccountName", _ FileSystemRights.ReadData, AccessControlType.Allow) Console.WriteLine("Done.") Catch e As Exception Console.WriteLine(e) End Try End Sub ' Adds an ACL entry on the specified file for the specified account. Sub AddFileSecurity(ByVal fileName As String, ByVal account As String, _ ByVal rights As FileSystemRights, ByVal controlType As AccessControlType) ' Get a FileSecurity object that represents the ' current security settings. Dim fSecurity As FileSecurity = File.GetAccessControl(fileName) ' Add the FileSystemAccessRule to the security settings. Dim accessRule As FileSystemAccessRule = _ New FileSystemAccessRule(account, rights, controlType) fSecurity.AddAccessRule(accessRule) ' Set the new access settings. File.SetAccessControl(fileName, fSecurity) End Sub ' Removes an ACL entry on the specified file for the specified account. Sub RemoveFileSecurity(ByVal fileName As String, ByVal account As String, _ ByVal rights As FileSystemRights, ByVal controlType As AccessControlType) ' Get a FileSecurity object that represents the ' current security settings. Dim fSecurity As FileSecurity = File.GetAccessControl(fileName) ' Remove the FileSystemAccessRule from the security settings. fSecurity.RemoveAccessRule(New FileSystemAccessRule(account, _ rights, controlType)) ' Set the new access settings. File.SetAccessControl(fileName, fSecurity) End Sub End Module
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.