Get-PSBreakpoint

Get-PSBreakpoint
    [[-Script] <String[]>]
    [-Runspace <Runspace>]
    [<CommonParameters>]

Get-PSBreakpoint
    [[-Script] <String[]>]
    -Command <String[]>
    [-Runspace <Runspace>]
    [<CommonParameters>]

Get-PSBreakpoint
    [[-Script] <String[]>]
    -Variable <String[]>
    [-Runspace <Runspace>]
    [<CommonParameters>]

Get-PSBreakpoint
    [[-Script] <String[]>]
    [-Type] <BreakpointType[]>
    [-Runspace <Runspace>]
    [<CommonParameters>]

Get-PSBreakpoint
    [-Id] <Int32[]>
    [-Runspace <Runspace>]
    [<CommonParameters>]

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 PowerShell scripts and commands. For more information about the PowerShell debugger, see about_Debuggers.

This command gets all breakpoints set on all scripts and functions in the current session.

Get-PSBreakpoint

This command gets the breakpoint with breakpoint ID 2.

Get-PSBreakpoint -Id 2

Function         :
IncrementAction  :
Enabled          :
TrueHitCount     : 0
Id               : 2
Script           : C:\ps-test\sample.ps1
ScriptName       : C:\ps-test\sample.ps1

These commands show how to get a breakpoint by piping a breakpoint ID to Get-PSBreakpoint.

$B = `Set-PSBreakpoint` -Script "sample.ps1" -Command "Increment"
$B.Id | Get-PSBreakpoint

The Set-PSBreakpoint cmdlet creates a breakpoint on the Increment function in the Sample.ps1 script and saves the breakpoint object in the $B variable. The Id property of the breakpoint object in the $B variable is piped to the Get-PSBreakpoint cmdlet to display the breakpoint information.

This command gets all of the breakpoints in the Sample.ps1 and SupportScript.ps1 files.

Get-PSBreakpoint -Script "Sample.ps1, SupportScript.ps1"

This command does not get other breakpoints that might be set in other scripts or on functions in the session.

This command gets all Command breakpoints that are set on Read-Host or Write-Host commands in the Sample.ps1 file.

Get-PSBreakpoint -Command "Read-Host, Write-Host" -Script "Sample.ps1"

Get-PSBreakpoint -Type Command -Script "Sample.ps1"

This command gets all Command breakpoints in the Sample.ps1 file.

This command gets breakpoints that are set on the $Index and $Swap variables in the current session.

Get-PSBreakpoint -Variable "Index, Swap"

This command gets all line and variable breakpoints in the Sample.ps1 script.

Get-PSBreakpoint -Type Line, Variable -Script "Sample.ps1"

In this example, a job is started and a breakpoint is set to break when the Set-PSBreakpoint is run. The runspace is stored in a variable and passed to the Get-PSBreakpoint command with the Runspace parameter. You can then inspect the breakpoint in the $breakpoint variable.

Start-Job -ScriptBlock {
    Set-PSBreakpoint -Command Start-Sleep
    Start-Sleep -Seconds 10
}

$runspace = Get-Runspace -Id 1

$breakpoint = Get-PSBreakpoint -Runspace $runspace

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

You can pipe breakpoint IDs to this cmdlet.

You can pipe breakpoint types to this cmdlet.

This cmdlet returns objects that represent the breakpoints in the session.

PowerShell includes the following aliases for Get-PSBreakpoint:

• All platforms:
  • gbp