Get-PSBreakpoint
現在のセッションで設定されたブレークポイントを取得します。
構文
Get-PSBreakpoint
[[-Script] <String[]>]
[-Runspace <Runspace>]
[<CommonParameters>]
Get-PSBreakpoint
[[-Script] <String[]>]
-Command <String[]>
[-Runspace <Runspace>]
[<CommonParameters>]
Get-PSBreakpoint
[[-Script] <String[]>]
-Variable <String[]>
[-Runspace <Runspace>]
[<CommonParameters>]
Get-PSBreakpoint
[[-Script] <String[]>]
[-Type] <BreakpointType[]>
[-Runspace <Runspace>]
[<CommonParameters>]
Get-PSBreakpoint
[-Id] <Int32[]>
[-Runspace <Runspace>]
[<CommonParameters>]
説明
コマンドレットは Get-PSBreakPoint
、現在のセッションで設定されているブレークポイントを取得します。 コマンドレットのパラメーターを使用して、特定のブレークポイントを取得できます。
ブレークポイントとは、実行を一時的に停止して命令を調べることができるようにするための、コマンドまたはスクリプト内のポイントです。 Get-PSBreakpoint
は、PowerShell スクリプトとコマンドのデバッグ用に設計されたいくつかのコマンドレットの 1 つです。 PowerShell デバッガーの詳細については、「 about_Debuggers」を参照してください。
例
例 1: すべてのスクリプトと関数のすべてのブレークポイントを取得する
このコマンドは、現在のセッション内のすべてのスクリプトおよび関数に設定されているすべてのブレークポイントを取得します。
Get-PSBreakpoint
例 2: ID でブレークポイントを取得する
このコマンドは、ブレークポイント ID が 2 のブレークポイントを取得します。
Get-PSBreakpoint -Id 2
Function :
IncrementAction :
Enabled :
TrueHitCount : 0
Id : 2
Script : C:\ps-test\sample.ps1
ScriptName : C:\ps-test\sample.ps1
例 3: ID を 'Get-PSBreakpoint' にパイプする
これらのコマンドは、ブレークポイント ID を にパイプ処理してブレークポイントを取得する方法を Get-PSBreakpoint
示しています。
$B = `Set-PSBreakpoint` -Script "sample.ps1" -Command "Increment"
$B.Id | Get-PSBreakpoint
コマンドレットは Set-PSBreakpoint
、スクリプトの Increment 関数にブレークポイントを Sample.ps1
作成し、ブレークポイント オブジェクトを 変数に $B
保存します。 変数内のブレークポイント オブジェクト$B
の Id プロパティは、ブレークポイント情報をGet-PSBreakpoint
表示するためにコマンドレットにパイプされます。
例 4: 指定したスクリプト ファイル内のブレークポイントを取得する
このコマンドは、 ファイルと SupportScript.ps1
ファイル内のすべてのブレークポイントをSample.ps1
取得します。
Get-PSBreakpoint -Script "Sample.ps1, SupportScript.ps1"
このコマンドは、他のスクリプトまたはセッション内の関数で設定される可能性のある他のブレークポイントを取得しません。
例 5: 指定したコマンドレットでブレークポイントを取得する
このコマンドは、 または ファイル内のコマンドにRead-Host
Write-Host
設定されているすべてのコマンド ブレークポイントをSample.ps1
取得します。
Get-PSBreakpoint -Command "Read-Host, Write-Host" -Script "Sample.ps1"
例 6: 指定したファイル内のコマンド ブレークポイントを取得する
Get-PSBreakpoint -Type Command -Script "Sample.ps1"
このコマンドは、Sample.ps1 ファイル内のすべてのコマンド ブレークポイントを取得します。
例 7: 変数でブレークポイントを取得する
このコマンドは、現在のセッションの 変数と $Swap
変数に$Index
設定されているブレークポイントを取得します。
Get-PSBreakpoint -Variable "Index, Swap"
例 8: ファイル内のすべての行ブレークポイントと変数ブレークポイントを取得する
このコマンドは、スクリプト内のすべての行ブレークポイントと変数ブレークポイントを Sample.ps1
取得します。
Get-PSBreakpoint -Type Line, Variable -Script "Sample.ps1"
例 9: 特定の実行空間に設定されたブレークポイントを取得する
この例では、ジョブが開始され、Set-PSBreakPoint
の実行時に中断するようにブレークポイントが設定されます。 実行空間は変数に格納され、Runspace パラメーターを使用して Get-PSBreakPoint
コマンドに渡されます。 その後、$breakpoint
変数内のブレークポイントを調べることができます。
Start-Job -ScriptBlock {
Set-PSBreakpoint -Command Start-Sleep
Start-Sleep -Seconds 10
}
$runspace = Get-Runspace -Id 1
$breakpoint = Get-PSBreakPoint -Runspace $runspace
パラメーター
-Command
指定したコマンド名に設定されているコマンド ブレークポイントの配列を指定します。 コマンドレットや関数の名前などのコマンド名を入力します。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
このコマンドレットが取得するブレークポイント ID を指定します。 ID をコンマ区切りリスト形式で入力します。 ブレークポイント ID を に Get-PSBreakpoint
パイプすることもできます。
Type: | Int32[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Runspace
指定した実行空間内のブレークポイントを操作できるように、 Runspace オブジェクトの ID を指定します。
このパラメーターは、PowerShell 7.2 で追加されました。
Type: | Runspace |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Script
ブレークポイントを含むスクリプトの配列を指定します。 1 つ以上のスクリプト ファイルのパス (省略可能) と名前を入力します。 パスを省略した場合、現在のディレクトリが既定の場所になります。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Type
このコマンドレットが取得するブレークポイントの種類の配列を指定します。 1 つまたは複数の型を入力します。 このパラメーターの有効値は、次のとおりです。
- 折れ線
- コマンド
- 変数
ブレークポイントの種類を に Get-PSBreakPoint
パイプすることもできます。
Type: | BreakpointType[] |
Accepted values: | Line, Variable, Command |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Variable
指定した変数名に設定されている変数ブレークポイントの配列を指定します。 ドル記号を付けずに変数名を入力します。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
ブレークポイント ID をこのコマンドレットにパイプできます。
ブレークポイントの種類をこのコマンドレットにパイプできます。
出力
このコマンドレットは、セッション内のブレークポイントを表す オブジェクトを返します。
メモ
PowerShell には、 の次のエイリアスが Get-PSBreakpoint
含まれています。
- すべてのプラットフォーム:
gbp