Share via

Get-PSBreakpoint

  • Reference
Module:
Microsoft.PowerShell.Utility

Gets the breakpoints that are set in the current session.

Syntax

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>]

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.

Examples

Example 1

Get-PSBreakpoint

Description

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

Example 2

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

$b = Set-PSBreakpoint -Script sample.ps1 -function increment
$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

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

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

Get-PSBreakpoint -Type Command -Script Sample.ps1

Description

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

Example 7

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

Get-PSBreakpoint -Type line, variable -Script Sample.ps1

Description

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

Parameters

-Command

Gets command breakpoints that are set on the specified command names. Enter the command names, such as the name of a cmdlet or function.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Id

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.

Type:Int32[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Script

Gets only the breakpoints in the specified scripts. Enter the path (optional) and names of one or more script files. If you omit the path, the default location is the current directory.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Type

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.

Type:BreakpointType[]
Position:1
Default value:All types
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Variable

Gets variable breakpoints that are set on the specified variable names. Enter the variable names without dollar signs.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.Int32, Microsoft.PowerShell.Commands.BreakpointType

You can pipe breakpoint IDs and breakpoint types to Get-PSBreakpoint.

Outputs

Breakpoint

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

Notes

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