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
HighThe action performed has a high risk of losing data, such as reformatting a hard disk.
LowThe action performed has a low risk of losing data.
MediumThe action performed has a medium risk of losing data.
NoneDo not confirm any actions (suppress all requests for confirmation).

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:
© 2014 Microsoft