powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-PSBreakpoint



NAME
Remove-PSBreakpoint

SYNOPSIS
Deletes breakpoints from the current console.

SYNTAX
Remove-PSBreakpoint [-Id] [-Confirm] [-WhatIf] []

Remove-PSBreakpoint [-Breakpoint] [-Confirm] [-WhatIf] []


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 break
point 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 informati
on about the Windows PowerShell debugger, see about_Debuggers.


PARAMETERS
-Breakpoint
Specifies the breakpoints to delete. Enter a variable that contains breakpoint objects or a command that gets b
reakpoint objects, such as a Get-PSBreakpoint command. You can also pipe breakpoint objects to Remove-PSBreakpo
int.

Required? true
Position? 1
Default value None
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Id
Deletes breakpoints with the specified breakpoint IDs.

Required? true
Position? 1
Default value None
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.Automation.Breakpoint
You can pipe breakpoint objects to Remove-PSBreakpoint.


OUTPUTS
None
The cmdlet does not generate any output.


NOTES





-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-breakpoint | remove-breakpoint


Description
-----------
This command deletes all of the breakpoints in the current console.





-------------------------- EXAMPLE 2 --------------------------

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 sc
ript. 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-PSBreakpo
int cmdlet does not return this breakpoint.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>remove-psbreakpoint -id 2


Description
-----------
This command deletes the breakpoint with breakpoint ID 2.





-------------------------- EXAMPLE 4 --------------------------

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 cmdle
t, 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.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113375
about_Debuggers
Set-PSBreakpoint
Get-PSBreakpoint
Enable-PSBreakpoint
Disable-PSBreakpoint
Get-PSCallStack