AvoidShouldContinueWithoutForce
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'))
{
...
}
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for