Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Severity Level: Warning
Description
Functions that use ShouldContinue should have a boolean force parameter to allow user to bypass it.
You can get more details by running Get-Help about_Functions_CmdletBindingAttribute and
Get-Help about_Functions_Advanced_Methods command in PowerShell.
How
Call the ShouldContinue method in advanced functions when ShouldProcess method returns $true.
Example
Wrong
Function Test-ShouldContinue
{
[CmdletBinding(SupportsShouldProcess=$true)]
Param
(
$MyString = 'blah'
)
if ($PsCmdlet.ShouldContinue('ShouldContinue Query', 'ShouldContinue Caption'))
{
...
}
}
Correct
Function Test-ShouldContinue
{
[CmdletBinding(SupportsShouldProcess=$true)]
Param
(
$MyString = 'blah',
[Switch]$Force
)
if ($Force -or $PsCmdlet.ShouldContinue('ShouldContinue Query', 'ShouldContinue Caption'))
{
...
}
}