This documentation is archived and is not being maintained.

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

The PipeAuditRule type exposes the following members.

Public methodPipeAuditRule(IdentityReference, PipeAccessRights, AuditFlags)Initializes a new instance of the PipeAuditRule class for a user account specified in a IdentityReference object.
Public methodPipeAuditRule(String, PipeAccessRights, AuditFlags)Initializes a new instance of the PipeAuditRule class for a named user account.

Protected propertyAccessMaskGets the access mask for this rule. (Inherited from AuthorizationRule.)
Public propertyAuditFlagsGets the audit flags for this audit rule. (Inherited from AuditRule.)
Public propertyIdentityReferenceGets the IdentityReference to which this rule applies. (Inherited from AuthorizationRule.)
Public propertyInheritanceFlagsGets the value of flags that determine how this rule is inherited by child objects. (Inherited from AuthorizationRule.)
Public propertyIsInheritedGets a value indicating whether this rule is explicitly set or is inherited from a parent container object. (Inherited from AuthorizationRule.)
Public propertyPipeAccessRightsGets the PipeAccessRights flags that are associated with the current PipeAuditRule object.
Public propertyPropagationFlagsGets 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.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns 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.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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