Get-PSBreakpoint

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

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

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

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

Get-PSBreakpoint
    [-Id] <Int32[]>
    [<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 Windows PowerShell scripts and commands. For more information about the Windows PowerShell debugger, see about_Debuggers.

PS C:\> Get-PSBreakpoint

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

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

This command gets the breakpoint with breakpoint ID 2.

PS C:\> $B = Set-PSBreakpoint -Script "sample.ps1" -Command "Increment"
PS C:\> $B.Id | Get-PSBreakpoint

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.

PS C:\> Get-PSBreakpoint -Script "Sample.ps1, SupportScript.ps1"

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.

PS C:\> Get-PSBreakpoint -Command "Read-Host, Write-Host" -Script "Sample.ps1"

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

PS C:\> Get-PSBreakpoint -Type Command -Script "Sample.ps1"

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

PS C:\> Get-PSBreakpoint -Variable "Index, Swap"

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

PS C:\> Get-PSBreakpoint -Type Line, Variable -Script "Sample.ps1"

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

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 and breakpoint types to Get-PSBreakPoint.

Get-PSBreakPoint returns objects that represent the breakpoints in the session.

• You can use Get-PSBreakpoint or its alias, "gbp".