Windows Dev Center

Expand Minimize

ConfirmImpact Enumeration

Defines the impact level of the action performed by the cmdlet. For example, cmdlets may have a high, medium, or low risk of losing data.


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

'Usage
Dim instance As ConfirmImpact

public enum ConfirmImpact
public enum ConfirmImpact
public enum ConfirmImpact

Member nameDescription
HighThis action is potentially highly "destructive" and should be confirmed by default unless otherwise specified.
LowThis action only needs to be confirmed when the user has requested that low-impact changes must be confirmed.
MediumThis action should be confirmed in most scenarios where confirmation is requested.
NoneThere is never any need to confirm this action.

This enumeration is used when setting the ConfirmImpact parameter of the Cmdlet attribute and the $ConfirmPreference shell variable. Remember that it is up to the developer to determine if their cmdlet or provider has a high, medium, or low risk of losing data.

Users can set the $ConfirmPreference shell variable so that only cmdlets and providers with an equal or higher impact level can request confirmation before they perform their operation. For example, if $ConfirmPreference is set to Medium, cmdlets and providers with a medium or high impact level can request confirmation. Requests from cmdlets and providers with a low impact level are suppressed.

For more information about impact level, see Requesting Confirmation.


 

Target Platforms


Show:
© 2015 Microsoft