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

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.

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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.

.NET Framework

Supported in: 3.5