CmdletAttribute.ConfirmImpact Property

Gets and sets the impact level of the operation performed by the cmdlet.

Namespace: System.Management.Automation
Assembly: System.Management.Automation (in system.management.automation.dll)

Usage

Syntax

'Declaration
Public Property ConfirmImpact As ConfirmImpact
public ConfirmImpact ConfirmImpact { get; set; }
public:
virtual property ConfirmImpact ConfirmImpact {
    ConfirmImpact get () sealed;
    void set (ConfirmImpact value) sealed;
}
/** @property */
public final ConfirmImpact get_ConfirmImpact ()

/** @property */
public final void set_ConfirmImpact (ConfirmImpact value)
public final function get ConfirmImpact () : ConfirmImpact

public final function set ConfirmImpact (value : ConfirmImpact)

Property Value

A ConfirmImpact enumeration constant that specifies the impact level of the operation performed by the cmdlet. The value of this parameter is used when the user requests confirmation using the $ConfirmPreference shell variable. Do not use the None constant to set this attribute parameter.

Remarks

This property is an optional Named parameter of the CmdletAttribute attribute, and should be specified only when the SupportsShouldProcess parameter is also set. In most cases, the default value of Medium should be used for this parameter. For more information about the declaration syntax used to specify the CmdletAttribute attribute, see CmdletAttribute Declaration.

For more information about impact level, see Requesting Confirmation.

Thread Safety

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

Platforms

Development Platforms

Windows Server 2008, Windows Vista, Windows Server 2003, Windows XP

Target Platforms

Windows Server 2008, Windows Server 2003, Windows Vista, Windows XP

See Also

Reference

CmdletAttribute Class
CmdletAttribute Members
System.Management.Automation Namespace
ConfirmImpact

Other Resources

Windows PowerShell SDK