Edit

Share via

Remove-PSBreakpoint

Module:
Microsoft.PowerShell.Utility Module

Deletes breakpoints from the current console.

Syntax

Breakpoint (Default) 

Remove-PSBreakpoint
    [-Breakpoint] <Breakpoint[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Id 

Remove-PSBreakpoint
    [-Id] <Int32[]>
    [-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-PSBreakpoint

Example 2: Remove a specified breakpoint

This command deletes a breakpoint.

$B = Set-PSBreakpoint -Script "sample.ps1" -Variable "Name"
$B | Remove-PSBreakpoint

The 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 2

Example 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.

Parameter properties

Type:

Breakpoint[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Breakpoint
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies breakpoint IDs for which this cmdlet deletes breakpoints.

Parameter properties

Type:

Int32[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Id
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Breakpoint

You can pipe breakpoint objects to this cmdlet.

Int32

Runspace

Outputs

None

This cmdlet returns no output.

Notes

Windows PowerShell includes the following aliases for Remove-PSBreakpoint:

  • rbp