Enable-PSBreakpoint
Applies To: Windows PowerShell 2.0
Enables the breakpoints in the current console.
Syntax
Enable-PSBreakpoint [-Id] <Int32[]> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Enable-PSBreakpoint [-Breakpoint] <Breakpoint[]> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Description
The Enable-PSBreakpoint cmdlet re-enables disabled breakpoints. You can use it to enable all breakpoints, or you can specify breakpoints by submitting breakpoint objects or breakpoint IDs.
A breakpoint is a point in a script where execution stops temporarily so that you can examine the instructions in the script. Newly created breakpoints are automatically enabled, but you can disable them by using the Disable-PSBreakpoint cmdlet.
Technically, this cmdlet changes the value of the Enabled property of a breakpoint object to True.
Enable-PSBreakpoint is one of several cmdlets designed for debugging Windows PowerShell scripts. For more information about the Windows PowerShell debugger, see about_Debuggers.
Parameters
-Breakpoint <Breakpoint[]>
Specifies the breakpoints to enable. 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 Enable-PSBreakpoint.
Required? |
true |
Position? |
1 |
Default Value |
None. |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Id <Int32[]>
Enables breakpoints that have the specified breakpoint IDs. The default value is all breakpoints. Enter the IDs or a variable that contains the IDs. (You cannot pipe IDs to Enable-PSBreakpoint.) To find the ID of a breakpoint, use the Get-PSBreakpoint cmdlet.
Required? |
true |
Position? |
1 |
Default Value |
None |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the enabled breakpoint. By default, this cmdlet does not generate any output.
Required? |
false |
Position? |
named |
Default Value |
No output |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
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 |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.
Inputs and Outputs
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 a breakpoint object to Enable-PSBreakpoint. |
Outputs |
None or System.Management.Automation.Breakpoint When you use the PassThru parameter, Enable-PSBreakpoint returns a breakpoint object that represent that breakpoint that was enabled. Otherwise, this cmdlet does not generate any output. |
Notes
The Enable-PSBreakpoint cmdlet does not generate an error if you try to enable a breakpoint that is already enabled. As such, you can enable all breakpoints without error, even when only a few are disabled.
Breakpoints are enabled when you create them by using the Set-PSBreakpoint cmdlet. You do not need to enable newly created breakpoints.
Example 1
C:\PS>get-psbreakpoint | enable-psbreakpoint
Description
-----------
This command enables all breakpoints in the current console. You can abbreviate the command as "gbp | ebp".
Example 2
C:\PS>enable-psbreakpoint -id 0, 1, 5
Description
-----------
This command enables breakpoints with breakpoint IDs 0, 1, and 5.
Example 3
C:\PS>$b = set-psbreakpoint -script sample.ps1 -variable Name
C:\PS> $b | disable-psbreakpoint -passthru
AccessMode : Write
Variable : Name
Action :
Enabled : False
HitCount : 0
Id : 0
Script : C:\ps-test\sample.ps1
ScriptName : C:\ps-test\sample.ps1
C:\PS> $b | enable-psbreakpoint -passthru
AccessMode : Write
Variable : Name
Action :
Enabled : True
HitCount : 0
Id : 0
Script : C:\ps-test\sample.ps1
ScriptName : C:\ps-test\sample.ps1
Description
-----------
These commands re-enable a breakpoint that has been disabled.
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 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, and it uses the PassThru parameter of Disable-PSBreakpoint to display the disabled breakpoint object. This lets you verify that the value of the Enabled property of the breakpoint object is False.
The third command uses the Enable-PSBreakpoint cmdlet to re-enable the breakpoint. It uses a pipeline operator (|) to send the breakpoint object in $b to the Enable-PSBreakpoint cmdlet, and it uses the PassThru parameter of Enable-PSBreakpoint to display the breakpoint object. This lets you verify that the value of the Enabled property of the breakpoint object is True.
The results are shown in the following sample output.
Example 4
C:\PS>$b = get-psbreakpoint -id 3, 5
C:\PS> enable-psbreakpoint -breakpoint $b
Description
-----------
These commands enable a set of breakpoints by specifying their breakpoint objects.
The first command uses the Get-PSBreakpoint cmdlet to get the breakpoints and saves them in the $b variable.
The second command uses the Enable-PSBreakpoint cmdlet and its Breakpoint parameter to enable the breakpoints.
This command is the equivalent of "enable-psbreakpoint -id 3, 5".
See Also
Concepts
about_Debuggers
Set-PSBreakpoint
Disable-PSBreakpoint
Get-PSBreakpoint
Remove-PSBreakpoint
Get-PSCallStack