PipeSecurity.RemoveAuditRule(PipeAuditRule) Method

Definition

Namespace:

System.IO.Pipes

Assembly:

System.IO.Pipes.AccessControl.dll

Removes an audit rule from the System Access Control List (SACL) that is associated with the current PipeSecurity object.

public:
 bool RemoveAuditRule(System::IO::Pipes::PipeAuditRule ^ rule);

public bool RemoveAuditRule (System.IO.Pipes.PipeAuditRule rule);

override this.RemoveAuditRule : System.IO.Pipes.PipeAuditRule -> bool

Public Function RemoveAuditRule (rule As PipeAuditRule) As Boolean

Parameters

rule

PipeAuditRule

The audit rule to remove.

Returns

Boolean

true if the audit rule was removed; otherwise, false.

Exceptions

ArgumentNullException

The rule parameter is null.

Remarks

The RemoveAuditRule method removes either all matching Deny audit rules or all matching Allow audit rules from the current PipeSecurity object. For example, you can use this method to remove all Deny audit rules for a user by passing a FileSystemAuditRule object created using the Deny value, the Failure value, and a user account. When you do this, the RemoveAuditRule method removes any deny rules that specify the Failure value or the Success value.