現在のセッションで設定されているプレークポイントを取得します。
構文
Get-PSBreakpoint [[-Script] <string[]>] [<CommonParameters>] Get-PSBreakpoint -Command <string[]> [-Script <string[]>] [<CommonParameters>] Get-PSBreakpoint [-Id] <Int32[]> [<CommonParameters>] Get-PSBreakpoint [-Type] <BreakpointType[]> [-Script <string[]>] [<CommonParameters>] Get-PSBreakpoint -変数 <string[]> [-Script <string[]>] [<CommonParameters>]
説明
Get-PSBreakPoint コマンドレットは、現在のセッションで設定されているプレークポイントを取得します。コマンドレット パラメーターを使用して、特定のブレークポイントを取得できます。
ブレークポイントとは、命令を調べることができるように実行が一時的に停止するコマンドまたはスクリプトのポイントです。Get-PSBreakpoint は、Windows PowerShell のスクリプトとコマンドをデバッグするために設計されたコマンドレットの 1 つです。Windows PowerShell デバッガーの詳細については、「about_Debuggers」を参照してください。
パラメーター
-Command <string[]>
指定されたコマンド名に設定されているコマンドのブレークポイントを取得します。コマンドレットや関数の名前などのコマンド名を入力します。
|
必須 |
true |
|
位置 |
named |
|
既定値 |
All breakpoints |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-Id <Int32[]>
指定されたブレークポイント ID を持つブレークポイントを取得します。ID をコンマ区切り一覧で入力します。Get-PSBreakpoint に対してブレークポイント ID をパイプ処理することもできます。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
All breakpoints |
|
パイプライン入力を許可する |
true (ByValue) |
|
ワイルドカード文字を許可する |
false |
-Script <string[]>
指定されたスクリプトのブレークポイントのみを取得します。1 つ以上のスクリプト ファイルのパス (オプション) と名前を入力します。既定の場所は現在のディレクトリです。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
All breakpoints |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-Type <BreakpointType[]>
指定された型のブレークポイントのみを取得します。1 つまたは複数の型を入力します。有効な値は Line、Command、および Variable です。Get-PSBreakpoint に対してブレークポイントの型をパイプ処理することもできます。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
All breakpoints |
|
パイプライン入力を許可する |
true (ByValue) |
|
ワイルドカード文字を許可する |
false |
-変数 <string[]>
指定された変数名に設定されている変数のブレークポイントを取得します。ドル記号を付けずに変数名を入力します。
|
必須 |
true |
|
位置 |
named |
|
既定値 |
All breakpoints |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
|
入力 |
System.Int32、Microsoft.PowerShell.Commands.BreakpointType Get-PSBreakpoint に対してブレークポイント ID とブレークポイントの型をパイプ処理できます。 |
|
出力 |
ブレークポイント オブジェクト (System.Management.Automation.LineBreakpoint、System.Management.Automation.VariableBreakpoint、System.Management.Automation.CommandBreakpoint) Get-PSBreakPoint は、セッション内のブレークポイントを表すオブジェクトを返します。 |
注
Get-PSBreakpoint またはそのエイリアスである "gbp" を使用できます。
例 1
C:\PS>get-psbreakpoint 説明 ----------- このコマンドは、現在のセッションのすべてのスクリプトと関数に設定されたすべてのブレークポイントを取得します。
例 2
C:\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 説明 ----------- このコマンドは、ブレークポイント ID が 2 であるブレークポイントを取得します。
例 3
C:\PS>$b = set-psbreakpoint -script sample.ps1 -function increment C:\PS> $b.Id | get-psbreakpoint 説明 ----------- これらのコマンドは、Get-PSBreakpoint に対してブレークポイント ID をパイプ処理することによって、ブレークポイントを取得する方法を示しています。 最初のコマンドは、Set-PSBreakpoint コマンドレットを使用して、Sample.ps1 スクリプトで Increment 関数にブレークポイントを作成します。そのブレークポイント オブジェクトは $b 変数に保存されます。 2 番目のコマンドは、ドット演算子 (.) を使用して、$b 変数にあるブレークポイント オブジェクトの Id プロパティを取得します。また、パイプライン演算子 (|) を使用して、ID を Get-PSBreakpoint コマンドレットに渡します。 その結果、Get-PSBreakpoint は指定された ID を持つブレークポイントを取得します。
例 4
C:\PS>get-psbreakpoint -script Sample.ps1, SupportScript.ps1 説明 ----------- このコマンドは、Sample.ps1 ファイルと SupportScript.ps1 ファイルにあるすべてのブレークポイントを取得します。 このコマンドは、セッションのその他のスクリプトまたは関数に設定できる他のブレークポイントは取得しません。
例 5
C:\PS>get-psbreakpoint -command Read-Host, Write-Host -script Sample.ps1 説明 ----------- このコマンドは、Sample.ps1 ファイルの Read-Host コマンドまたは Write-Host コマンドに設定されているすべての Command ブレークポイントを取得します。
例 6
C:\PS>get-psbreakpoint -type Command -script Sample.ps1 説明 ----------- このコマンドは、Sample.ps1 ファイルにあるすべての Command ブレークポイントを取得します。
例 7
C:\PS>get-psbreakpoint -variable Index, Swap 説明 ----------- このコマンドは、現在のセッションの $index 変数と $swap 変数に設定されているブレークポイントを取得します。
例 8
C:\PS>get-psbreakpoint -type line, variable -script Sample.ps1 説明 ----------- このコマンドは、Sample.ps1 スクリプトのすべての行および変数のブレークポイントを取得します。
関連項目