Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FileSystemAuditRule Class

 

Represents an abstraction of an access control entry (ACE) that defines an audit rule for a file or directory. This class cannot be inherited.

Namespace:   System.Security.AccessControl
Assembly:  mscorlib (in mscorlib.dll)

System::Object
  System.Security.AccessControl::AuthorizationRule
    System.Security.AccessControl::AuditRule
      System.Security.AccessControl::FileSystemAuditRule

public ref class FileSystemAuditRule sealed : AuditRule

NameDescription
System_CAPS_pubmethodFileSystemAuditRule(IdentityReference^, FileSystemRights, AuditFlags)

Initializes a new instance of the FileSystemAuditRule class using a reference to a user account, a value that specifies the type of operation associated with the audit rule, and a value that specifies when to perform auditing.

System_CAPS_pubmethodFileSystemAuditRule(IdentityReference^, FileSystemRights, InheritanceFlags, PropagationFlags, AuditFlags)

Initializes a new instance of the FileSystemAuditRule class using the name of a reference to a user account, a value that specifies the type of operation associated with the audit rule, a value that determines how rights are inherited, a value that determines how rights are propagated, and a value that specifies when to perform auditing.

System_CAPS_pubmethodFileSystemAuditRule(String^, FileSystemRights, AuditFlags)

Initializes a new instance of the FileSystemAuditRule class using a user account name, a value that specifies the type of operation associated with the audit rule, and a value that specifies when to perform auditing.

System_CAPS_pubmethodFileSystemAuditRule(String^, FileSystemRights, InheritanceFlags, PropagationFlags, AuditFlags)

Initializes a new instance of the FileSystemAuditRule class using the name of a user account, a value that specifies the type of operation associated with the audit rule, a value that determines how rights are inherited, a value that determines how rights are propagated, and a value that specifies when to perform auditing.

NameDescription
System_CAPS_protpropertyAccessMask

Gets the access mask for this rule.(Inherited from AuthorizationRule.)

System_CAPS_pubpropertyAuditFlags

Gets the audit flags for this audit rule.(Inherited from AuditRule.)

System_CAPS_pubpropertyFileSystemRights

Gets the FileSystemRights flags associated with the current FileSystemAuditRule object.

System_CAPS_pubpropertyIdentityReference

Gets the IdentityReference to which this rule applies.(Inherited from AuthorizationRule.)

System_CAPS_pubpropertyInheritanceFlags

Gets the value of flags that determine how this rule is inherited by child objects.(Inherited from AuthorizationRule.)

System_CAPS_pubpropertyIsInherited

Gets a value indicating whether this rule is explicitly set or is inherited from a parent container object.(Inherited from AuthorizationRule.)

System_CAPS_pubpropertyPropagationFlags

Gets the value of the propagation flags, which determine how inheritance of this rule is propagated to child objects. This property is significant only when the value of the InheritanceFlags enumeration is not None.(Inherited from AuthorizationRule.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The FileSystemAuditRule class represents an abstraction of an underlying access control entry (ACE) that specifies a user account, the type of access to provide (read, write, and so on), and whether to perform auditing. This class can also specify how audit rules are inherited from and propagated to objects.

To permit file and directory auditing on Windows NT or later, you must enable Audit Access Security policy on your machine. By default, this policy is set to No Auditing.

To enable the Audit Access Security policy, perform the following steps:

  1. Open the Local Security Settings Microsoft Management Console (MMC) snap-in, located in the Administrative Tools folder.

  2. Expand the Local Policies folder and left-click the Audit Policy folder.

  3. Double-click the Audit object access entry on the right pane of the MMC snap-in, or right-click and choose Properties to display the Audit object access properties dialog box.

  4. Select the Success or Failure check boxes to log successes or failures.

Note that an audit rule for a user account requires a corresponding access rule for the same user account.

Use the FileSystemAuditRule class to create a new audit rule. You can persist this rule using the FileSecurity or DirectorySecurity class.

The following code example uses the FileSystemAuditRule class to add and then remove an audit rule from a file. You must supply a valid user or group account to run this example.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2017 Microsoft