Get-PSBreakpoint

Updated: August 9, 2015

Get-PSBreakpoint

Gets the breakpoints that are set in the current session.

Syntax

Parameter Set: Script
Get-PSBreakpoint [[-Script] <String[]> ] [ <CommonParameters>]

Parameter Set: Command
Get-PSBreakpoint -Command <String[]> [-Script <String[]> ] [ <CommonParameters>]

Parameter Set: Id
Get-PSBreakpoint [-Id] <Int32[]> [ <CommonParameters>]

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

Parameter Set: Variable
Get-PSBreakpoint -Variable <String[]> [-Script <String[]> ] [ <CommonParameters>]




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

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id<Int32[]>

Specifies the breakpoint IDs that this cmdlet gets. Enter the IDs in a comma-separated list. You can also pipe breakpoint IDs to Get-PSBreakpoint.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Script<String[]>

Specifies an array of scripts that contain the breakpoints. Enter the path and names of one or more script files. If you omit the path, the default location is the current directory.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Type<BreakpointType[]>

Specifies an array of breakpoint types that this cmdlet gets. Enter one or more types. The acceptable values for this parameter are:

-- Line
-- Command
-- Variable

You can also pipe breakpoint types to Get-PSBreakPoint.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Variable<String[]>

Specifies an array of variable breakpoints that are set on the specified variable names. Enter the variable names without dollar signs.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Int32, Microsoft.PowerShell.Commands.BreakpointType

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


Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

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

Examples

Example 1: Get all breakpoints for all scripts and functions

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


PS C:\>Get-PSBreakpoint

Example 2: Get breakpoints by ID

This command gets the breakpoint with breakpoint ID 2.


PS C:\>Get-PSBreakpoint -Id 2

Example 3: Pipe an ID to 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:\>$B = Set-PSBreakpoint -Script "sample.ps1" -Command "Increment"
PS C:\> $B.Id | Get-PSBreakpoint

Example 4: Get breakpoints in specified script files

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 -Script "Sample.ps1, SupportScript.ps1"

Example 5: Get breakpoints in specified cmdlets

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 -Command "Read-Host, Write-Host" -Script "Sample.ps1"

Example 6: Get Command breakpoints in a specified file

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


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

Example 7: Get breakpoints by variable

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


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

Example 8: Get all Line and Variable breakpoints in a file

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


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

Related topics

Community Additions

ADD
Show: