PipeAuditRule Class

PipeAuditRule Class


Represents an abstraction of an access control entry (ACE) that defines an audit rule for a pipe.

Namespace:   System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class PipeAuditRule : AuditRule

System_CAPS_pubmethodPipeAuditRule(IdentityReference, PipeAccessRights, AuditFlags)

Initializes a new instance of the PipeAuditRule class for a user account specified in a IdentityReference object.

System_CAPS_pubmethodPipeAuditRule(String, PipeAccessRights, AuditFlags)

Initializes a new instance of the PipeAuditRule class for a named user account.


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


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


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


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


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


Gets the PipeAccessRights flags that are associated with the current PipeAuditRule object.


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.)


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


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


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


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

Audit rules determine when and how actions performed on system objects are logged.

The PipeAuditRule 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 specify how audit rules are inherited from and propagated to objects.

To allow file auditing on computers that are running Windows NT or later operating systems, the Audit Access Security policy must be enabled; by default, this policy is set to No Auditing.

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

  1. Click the Start button and then point to All Programs. Point to Administrative Tools and then click Local Security Policy.

  2. In the Local Security Settings window, expand the Local Policies folder and left-click the Audit Policy folder.

  3. Double-click the Audit object access entry in the right pane of the Local Security Settings window to display the Audit object access Properties dialog box.

  4. Select the Success or Failure 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 PipeAuditRule class to create a new audit rule. You can persist this rule using the PipeSecurity class.

.NET Framework
Available since 3.5

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
© 2015 Microsoft