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.

ShouldProcessReason Enumeration

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Defines any special circumstances surrounding the call to the Cmdlet.ShouldProcess, ICommandRuntime.ShouldProcess, or CmdletProvider.ShouldProcess method. For example, one circumstance may be because the WhatIf parameter was specified at the command line.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

<FlagsAttribute>
Public Enumeration ShouldProcessReason

Member nameDescription
None

none of the reasons below

WhatIf

WhatIf behavior was requested.

WhatIf behavior can be requested explicitly using the WhatIf parameter of the cmdlet, or implicitly for all cmdlets that support ShouldProcess by setting the $WhatIfPreference variable. Other hosts may have other ways to request WhatIf behavior.

Return to top
Show: