Remove-PSBreakpoint
Applies To: Windows PowerShell 2.0
Deletes breakpoints from the current console.
Remove-PSBreakpoint [-Id] <Int32[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-PSBreakpoint [-Breakpoint] <Breakpoint[]> [-Confirm] [-WhatIf] [<CommonParameters>]
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 Windows PowerShell scripts. For more information about the Windows PowerShell debugger, see about_Debuggers.
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.
Required? |
true |
Position? |
1 |
Default Value |
None |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
Deletes breakpoints with the specified breakpoint IDs.
Required? |
true |
Position? |
1 |
Default Value |
None |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
Inputs |
System.Management.Automation.Breakpoint You can pipe breakpoint objects to Remove-PSBreakpoint. |
Outputs |
None The cmdlet does not generate any output. |
C:\PS>get-breakpoint | remove-breakpoint
Description
-----------
This command deletes all of the breakpoints in the current console.
C:\PS>$b = set-psbreakpoint -script sample.ps1 -variable Name
C:\PS> $b | remove-psbreakpoint
Description
-----------
This command deletes a breakpoint.
The first command uses the Set-PSBreakpoint cmdlet to create a breakpoint on the Name variable in the Sample.ps1 script. Then, it saves the breakpoint object in the $b variable.
The second command uses the Remove-PSBreakpoint cmdlet to delete 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.
C:\PS>remove-psbreakpoint -id 2
Description
-----------
This command deletes the breakpoint with breakpoint ID 2.
C:\PS>function del-psb { get-psbreakpoint | remove-psbreakpoint }
Description
-----------
This simple function deletes all of the breakpoints in the current console. 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.
As a result, you can type "del-psb" instead of the longer command.
To save the function, add it to your Windows PowerShell profile.
about_Debuggers
Set-PSBreakpoint
Get-PSBreakpoint
Enable-PSBreakpoint
Disable-PSBreakpoint
Get-PSCallStack