| external help file | Locale | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Microsoft.PowerShell.Commands.Utility.dll-Help.xml |
en-US |
Microsoft.PowerShell.Utility |
08/19/2021 |
2.0.0 |
Remove-PSBreakpoint |
Remove-PSBreakpoint
SYNOPSIS
Deletes breakpoints from the current console.
SYNTAX
Breakpoint (Default)
Remove-PSBreakpoint [-Breakpoint] <Breakpoint[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Id
Remove-PSBreakpoint [-Id] <Int32[]> [-Runspace <Runspace>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Remove-PSBreakpoint cmdlet deletes a breakpoint. Enter a breakpoint object or a breakpoint ID.
When you remove a breakpoint, the breakpoint object is no longer available or functional. If you have saved a breakpoint object in a variable, the reference still exists, but the breakpoint does not function.
Remove-PSBreakpoint is one of several cmdlets designed for debugging PowerShell scripts. For more
information about the PowerShell debugger, see
about_Debuggers.
EXAMPLES
Example 1: Remove all breakpoints
This command deletes all of the breakpoints in the current console.
Get-PSBreakpoint | Remove-PSBreakpointExample 2: Remove a specified breakpoint
This command deletes a breakpoint.
$B = Set-PSBreakpoint -Script "sample.ps1" -Variable "Name"
$B | Remove-PSBreakpointThe Set-PSBreakpoint cmdlet creates a breakpoint on the $Name variable in the Sample.ps1
script and saves the breakpoint object in the $B variable. The Remove-PSBreakpoint cmdlet
deletes the new breakpoint. It uses a pipeline operator (|) to send the breakpoint object in the
$B variable to the Remove-PSBreakpoint cmdlet.
As a result of this command, if you run the script, it runs to completion without stopping. Also,
the Get-PSBreakpoint cmdlet does not return this breakpoint.
Example 3: Remove a breakpoint by ID
This command deletes the breakpoint with breakpoint ID 2.
Remove-PSBreakpoint -Id 2Example 4: Use a function to remove all breakpoints
This simple function deletes all of the breakpoints in the current console.
function del-psb { Get-PSBreakpoint | Remove-PSBreakpoint }It uses the Get-PSBreakpoint cmdlet to get the breakpoints. Then, it uses a pipeline operator
(|) to send the breakpoints to the Remove-PSBreakpoint cmdlet, which deletes them.
PARAMETERS
-Breakpoint
Specifies the breakpoints to delete. Enter a variable that contains breakpoint objects or a command
that gets breakpoint objects, such as a Get-PSBreakpoint command. You can also pipe breakpoint
objects to Remove-PSBreakpoint.
Type: System.Management.Automation.Breakpoint[]
Parameter Sets: Breakpoint
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False-Id
Specifies breakpoint IDs for which this cmdlet deletes breakpoints.
Type: System.Int32[]
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-Runspace
Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace.
Type: Runspace
Parameter Sets: Id
Aliases: RunspaceId
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False-Confirm
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseCommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.Management.Automation.Breakpoint[]
You can pipe breakpoint objects to Remove-PSBreakpoint.
System.Int32[]
System.Management.Automation.Runspaces.Runspace
OUTPUTS
None
The cmdlet does not generate any output.