Skip to content

Remove-PSBreakpoint.md

Latest commit

 

History

History
236 lines (163 loc) · 5.74 KB

Remove-PSBreakpoint.md

File metadata and controls

236 lines (163 loc) · 5.74 KB
external help file Microsoft.PowerShell.Commands.Utility.dll-Help.xml
Locale en-US
Module Name Microsoft.PowerShell.Utility
ms.date 01/20/2023
online version https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/remove-psbreakpoint?view=powershell-7.6&WT.mc_id=ps-gethelp
schema 2.0.0
aliases
rbp
title 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-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 the breakpoints in the current session.

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.

Example 5: Remove a breakpoint in a runspace

In this example, a job is started and a breakpoint is set to break when the Set-PSBreakpoint is run. The runspace is stored in a variable and passed to the Get-PSBreakpoint command with the Runspace parameter. The output of Get-PSBreakpoint is piped to Remove-PSBreakpoint to remove the breakpoint in the runspace.

Start-Job -ScriptBlock {
    Set-PSBreakpoint -Command Start-Sleep
    Start-Sleep -Seconds 10
}

$runspace = Get-Runspace -Id 1

Get-PSBreakpoint -Runspace $runspace | Remove-Breakpoint -Runspace $runspace

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.

This parameter was added in PowerShell 7.2.

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: False

CommonParameters

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 this cmdlet.

System.Int32[]

System.Management.Automation.Runspaces.Runspace

OUTPUTS

None

This cmdlet returns no output.

NOTES

PowerShell includes the following aliases for Remove-PSBreakpoint:

  • All platforms:
    • rbp

RELATED LINKS

Disable-PSBreakpoint

Enable-PSBreakpoint

Get-PSBreakpoint

Get-PSCallStack

Set-PSBreakpoint