次の方法で共有

Get-PSBreakpoint

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

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

構文

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 コマンドレットは、Sample.ps1 スクリプトの Increment 関数にブレークポイントを作成し、ブレークポイント オブジェクトを$B変数に保存します。 $B変数内のブレークポイント オブジェクトの Id プロパティは、ブレークポイント情報を表示するためにGet-PSBreakpoint コマンドレットにパイプされます。

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

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

Get-PSBreakpoint -Script "Sample.ps1, SupportScript.ps1"

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

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

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

Get-PSBreakpoint -Command "Read-Host, Write-Host" -Script "Sample.ps1"

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

Get-PSBreakpoint -Type Command -Script "Sample.ps1"

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

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

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

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

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

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

-Id

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

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

-Runspace

指定した実行空間内のブレークポイントと対話できるように、 Runspace オブジェクトの ID を指定します。

このパラメーターは PowerShell 7.2 で追加されました。

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

-Script

ブレークポイントを含むスクリプトの配列を指定します。 1 つまたは複数のスクリプト ファイルのパス (省略可能) と名前を入力します。 パスを省略した場合、現在のディレクトリが既定の場所になります。

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

-Type

このコマンドレットが取得するブレークポイントの種類の配列を指定します。 1 つまたは複数の型を入力します。 このパラメーターの有効値は、次のとおりです。

  • ライン
  • command
  • 変数

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

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

-Variable

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

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

入力

Int32

ブレークポイント ID をこのコマンドレットにパイプできます。

BreakpointType

ブレークポイントの種類をこのコマンドレットにパイプできます。

出力

CommandBreakpoint

LineBreakpoint

VariableBreakpoint

Breakpoint

このコマンドレットは、セッション内のブレークポイントを表すオブジェクトを返します。

メモ

PowerShell には、 Get-PSBreakpointの次のエイリアスが含まれています。

  • すべてのプラットフォーム:
    • gbp