Get-PSBreakpoint

モジュール:: Microsoft.PowerShell.Utility

現在のセッションで設定されているブレークポイントを取得します。

構文

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

説明

Get-PSBreakPoint コマンドレットは、現在のセッションで設定されたブレークポイントを取得します。コマンドレットパラメーターを使用して、特定のブレークポイントを取得できます。

ブレークポイントは、命令を調べることができるように、実行が一時的に停止するコマンドまたはスクリプト内のポイントです。 Get-PSBreakpoint は、Windows PowerShell スクリプトとコマンドのデバッグ用に設計されたいくつかのコマンドレットの 1 つです。 Windows PowerShell デバッガーの詳細については、「about_Debuggers」を参照してください。

例

例 1: すべてのスクリプトと関数のすべてのブレークポイントを取得する

PS C:\> Get-PSBreakpoint

このコマンドは、現在のセッションのすべてのスクリプトと関数に設定されているすべてのブレークポイントを取得します。

例 2: ID でブレークポイントを取得する

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

このコマンドは、ブレークポイント ID 2 のブレークポイントを取得します。

例 3: ID を Get-PSBreakpoint にパイプする

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

これらのコマンドは、ブレークポイント ID を Get-PSBreakpoint にパイプしてブレークポイントを取得する方法を示しています。

最初のコマンドでは、Set-PSBreakpoint コマンドレットを使用して、Sample.ps1 スクリプトの Increment 関数にブレークポイントを作成します。ブレークポイントオブジェクトを $B 変数に保存します。

2 番目のコマンドは、ドット演算子 (.) を使用して、$B 変数内のブレークポイントオブジェクトの Id プロパティを取得します。パイプライン演算子 (|) を使用して、ID を Get-PSBreakpoint コマンドレットに送信します。

その結果、 Get-PSBreakpoint は指定された ID のブレークポイントを取得します。

例 4: 指定したスクリプトファイル内のブレークポイントを取得する

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

このコマンドは、Sample.ps1 ファイルと SupportScript.ps1 ファイル内のすべてのブレークポイントを取得します。

このコマンドは、他のスクリプトまたはセッション内の関数で設定される可能性のある他のブレークポイントを取得しません。

例 5: 指定したコマンドレットでブレークポイントを取得する

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

このコマンドは、Sample.ps1 ファイル内の Read-Host コマンドまたは Write-Host コマンドに設定されているすべてのコマンドブレークポイントを取得します。

例 6: 指定したファイル内のコマンドブレークポイントを取得する

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

このコマンドは、Sample.ps1 ファイル内のすべてのコマンドブレークポイントを取得します。

例 7: 変数でブレークポイントを取得する

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

このコマンドは、現在のセッションの$Index変数と$Swap変数に設定されたブレークポイントを取得します。

例 8: ファイル内のすべての行ブレークポイントと変数ブレークポイントを取得する

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

このコマンドは、Sample.ps1 スクリプト内のすべての行と変数のブレークポイントを取得します。

パラメーター

-Command

指定したコマンド名に設定されているコマンドブレークポイントの配列を指定します。コマンドレットや関数の名前などのコマンド名を入力します。

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Id

このコマンドレットが取得するブレークポイント ID を指定します。コンマ区切りのリストに ID を入力します。ブレークポイント ID を Get-PSBreakpoint にパイプすることもできます。

型:	Int32[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Script

ブレークポイントを含むスクリプトの配列を指定します。 1 つ以上のスクリプトファイルのパスと名前を入力します。パスを省略した場合、既定の場所は現在のディレクトリです。

型:	String[]
配置:	0
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Type

このコマンドレットが取得するブレークポイントの種類の配列を指定します。 1 つ以上の型を入力します。このパラメーターに使用できる値は次のとおりです。

線
コマンド
変数

ブレークポイントの種類を Get-PSBreakPoint にパイプ処理することもできます。

型:	BreakpointType[]
指定可能な値:	Line, Variable, Command
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Variable

指定した変数名に設定されている変数ブレークポイントの配列を指定します。変数名をドル記号なしで入力します。

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

System.Int32, Microsoft.PowerShell.Commands.BreakpointType

ブレークポイント ID とブレークポイントの種類を Get-PSBreakPoint にパイプできます。

出力

Breakpoint

Get-PSBreakPoint は、セッション内のブレークポイントを表すオブジェクトを返します。

メモ

Get-PSBreakpoint またはそのエイリアス「gbp」を使用できます。