powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Disable-PSBreakpoint



NAME
Disable-PSBreakpoint

SYNOPSIS
Disables the breakpoints in the current console.

SYNTAX
Disable-PSBreakpoint [-Id] [-PassThru] [-Confirm] [-WhatIf] []

Disable-PSBreakpoint [-Breakpoint] [-PassThru] [-Confirm] [-WhatIf] []


DESCRIPTION
The Disable-PSBreakpoint cmdlet disables breakpoints, which assures that they are not hit when the script runs. You
can use it to disable all breakpoints, or you can specify breakpoints by submitting breakpoint objects or breakpoi
nt IDs.

Technically, this cmdlet changes the value of the Enabled property of a breakpoint object to False. To re-enable a
breakpoint, use the Enable-PSBreakpoint cmdlet. Breakpoints are enabled by default when you create them by using th
e Set-PSBreakpoint cmdlet.

A breakpoint is a point in a script where execution stops temporarily so that you can examine the instructions in t
he script. Disable-PSBreakpoint is one of several cmdlets designed for debugging Windows PowerShell scripts. For mo
re information about the Windows PowerShell debugger, see about_Debuggers.


PARAMETERS
-Breakpoint
Specifies the breakpoints to disable. 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 the Disable-PSB
reakpoint cmdlet.

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

-Id
Disables the breakpoints with the specified breakpoint IDs. Enter the IDs or a variable that contains the IDs.
You cannot pipe IDs to Disable-PSBreakpoint.

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

-PassThru []
Returns an object representing the enabled breakpoints. By default, this cmdlet does not generate any output.

Required? false
Position? named
Default value None
Accept pipeline input? false
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 a breakpoint object to Disable-PSBreakpoint.


OUTPUTS
None or System.Management.Automation.Breakpoint
When you use the PassThru parameter, Disable-PSBreakpoint returns an object that represents the disabled breakp
oint. Otherwise, this cmdlet does not generate any output.


NOTES





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

C:\PS>$b = set-psbreakpoint -script sample.ps1 -variable name

C:\PS> $b | disable-psbreakpoint


Description
-----------
These commands disable a newly-created 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 Disable-PSBreakpoint cmdlet to disable the new breakpoint. It uses a pipeline operator
(|) to send the breakpoint object in $b to the Disable-PSBreakpoint cmdlet.

As a result of this command, the value of the Enabled property of the breakpoint object in $b is False.





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

C:\PS>disable-psbreakpoint -id 0


Description
-----------
This command disables the breakpoint with breakpoint ID 0.





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

C:\PS>disable-psbreakpoint -breakpoint ($b = set-psbreakpoint -script sample.ps1 -line 5)

C:\PS> $b


Description
-----------
This command creates a new breakpoint that is disabled until you enable it.

It uses the Disable-PSBreakpoint cmdlet to disable the breakpoint. The value of the Breakpoint parameter is a Set-P
SBreakpoint command that sets a new breakpoint, generates a breakpoint object, and saves the object in the $b varia
ble.

Cmdlet parameters that take objects as their values can accept a variable that contains the object or a command tha
t gets or generates the object. In this case, because Set-PSBreakpoint generates a breakpoint object, it can be use
d as the value of the Breakpoint parameter.

The second command displays the breakpoint object in the value of the $b variable.





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

C:\PS>get-psbreakpoint | disable-psbreakpoint


Description
-----------
This command disables all breakpoints in the current console. You can abbreviate this command as: "gbp | dbp".






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