Gets the breakpoints that are set in the current session.
Syntax
 Copy Code |
|
|---|---|
Get-PSBreakpoint [[-Script] <string[]>] [<CommonParameters>] Get-PSBreakpoint -Command <string[]> [-Script <string[]>] [<CommonParameters>] Get-PSBreakpoint [-Id] <Int32[]> [<CommonParameters>] Get-PSBreakpoint [-Type] <BreakpointType[]> [-Script <string[]>] [<CommonParameters>] Get-PSBreakpoint -Variable <string[]> [-Script <string[]>] [<CommonParameters>] |
|
Description
The Get-PSBreakPoint cmdlet gets the breakpoints that are set in the current session. You can use the cmdlet parameters to get particular breakpoints.
A breakpoint is a point in a command or script where execution stops temporarily so that you can examine the instructions. Get-PSBreakpoint is one of several cmdlets designed for debugging Windows PowerShell scripts and commands. For more information about the Windows PowerShell debugger, see about_Debuggers.
Parameters
-Command <string[]>
Gets command breakpoints that are set on the specified command names. Enter the command names, such as the name of a cmdlet or function.
|
Required? |
true |
|
Position? |
named |
|
Default Value |
All breakpoints |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Id <Int32[]>
Gets the breakpoints with the specified breakpoint IDs. Enter the IDs in a comma-separated list. You can also pipe breakpoint IDs to Get-PSBreakpoint.
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
All breakpoints |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Script <string[]>
Gets only the breakpoints in the specified scripts. Enter the path (optional) and names of one or more script files. The default location is the current directory.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
All breakpoints |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Type <BreakpointType[]>
Gets only breakpoints of the specified types. Enter one or more types. Valid values are Line, Command, and Variable. You can also pipe breakpoint types to Get-PSBreakpoint.
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
All breakpoints |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Variable <string[]>
Gets variable breakpoints that are set on the specified variable names. Enter the variable names without dollar signs.
|
Required? |
true |
|
Position? |
named |
|
Default Value |
All breakpoints |
|
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.Int32, Microsoft.PowerShell.Commands.BreakpointType You can pipe breakpoint IDs and breakpoint types to Get-PSBreakpoint. |
|
Outputs |
Breakpoint object (System.Management.Automation.LineBreakpoint, System.Management.Automation.VariableBreakpoint, System.Management.Automation.CommandBreakpoint) Get-PSBreakPoint returns objects that represent the breakpoints in the session. |
Notes
You can use Get-PSBreakpoint or its alias, "gbp".
Example 1
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint |
|
Description
-----------
This command gets all breakpoints set on all scripts and functions in the current session.
Example 2
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint -Id 2 Function : Increment Action : Enabled : True HitCount : 0 Id : 2 Script : C:\ps-test\sample.ps1 ScriptName : C:\ps-test\sample.ps1 |
|
Description
-----------
This command gets the breakpoint with breakpoint ID 2.
Example 3
| Copy Code |
|
|---|---|
C:\PS>$b = set-psbreakpoint -script sample.ps1 -function increment C:\PS> $b.Id | get-psbreakpoint |
|
Description
-----------
These commands show how to get a breakpoint by piping a breakpoint ID to Get-PSBreakpoint.
The first command uses the Set-PSBreakpoint cmdlet to create a breakpoint on the Increment function in the Sample.ps1 script. It saves the breakpoint object in the $b variable.
The second command uses the dot operator (.) to get the Id property of the breakpoint object in the $b variable. It uses a pipeline operator (|) to send the ID to the Get-PSBreakpoint cmdlet.
As a result, Get-PSBreakpoint gets the breakpoint with the specified ID.
Example 4
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint -script Sample.ps1, SupportScript.ps1 |
|
Description
-----------
This command gets all of the breakpoints in the Sample.ps1 and SupportScript.ps1 files.
This command does not get other breakpointS that might be set in other scripts or on functions in the session.
Example 5
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint -command Read-Host, Write-Host -script Sample.ps1 |
|
Description
-----------
This command gets all Command breakpoints that are set on Read-Host or Write-Host commands in the Sample.ps1 file.
Example 6
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint -type Command -script Sample.ps1 |
|
Description
-----------
This command gets all Command breakpoints in the Sample.ps1 file.
Example 7
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint -variable Index, Swap |
|
Description
-----------
This command gets breakpoints that are set on the $index and $swap variables in the current session.
Example 8
| Copy Code |
|
|---|---|
C:\PS>get-psbreakpoint -type line, variable -script Sample.ps1 |
|
Description
-----------
This command gets all line and variable breakpoints in the Sample.ps1 script.