Remove-PSBreakpoint

現在のコンソールからブレークポイントを削除します。

構文

Remove-PSBreakpoint
      [-Breakpoint] <Breakpoint[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-PSBreakpoint
      [-Id] <Int32[]>
      [-Runspace <Runspace>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-PSBreakpoint コマンドレットはブレークポイントを削除します。 ブレークポイント オブジェクトまたはブレークポイント ID を入力します。

ブレークポイントを削除すると、ブレークポイント オブジェクトは使用できないか、機能不能となります。 ブレークポイント オブジェクトを変数を保存した場合、参照は存続するが、ブレークポイントは機能しません。

Remove-PSBreakpoint は、PowerShell スクリプトのデバッグ用に設計されたいくつかのコマンドレットの 1 つです。 PowerShell デバッガーの詳細については、「 about_Debuggers」を参照してください。

例 1: すべてのブレークポイントを削除する

このコマンドは、現在のコンソール内のすべてのブレークポイントを削除します。

Get-PSBreakpoint | Remove-PSBreakpoint

例 2: 指定したブレークポイントを削除する

このコマンドは、ブレークポイントを削除します。

$B = Set-PSBreakpoint -Script "sample.ps1" -Variable "Name"
$B | Remove-PSBreakpoint

Set-PSBreakpoint コマンドレットは、Sample.ps1 スクリプトの$Name変数にブレークポイントを作成し、ブレークポイント オブジェクトを$B変数に保存します。 Remove-PSBreakpoint コマンドレットは、新しいブレークポイントを削除します。 パイプライン演算子 (|) を使用して、 $B 変数のブレークポイント オブジェクトを Remove-PSBreakpoint コマンドレットに送信します。

このコマンドの結果、スクリプトを実行した場合、停止することなく完了するまで実行されます。 また、 Get-PSBreakpoint コマンドレットはこのブレークポイントを返しません。

例 3: ID でブレークポイントを削除する

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

Remove-PSBreakpoint -Id 2

例 4: 関数を使用してすべてのブレークポイントを削除する

この単純な関数は、現在のセッション内のすべてのブレークポイントを削除します。

function del-psb { Get-PSBreakpoint | Remove-PSBreakpoint }

Get-PSBreakpoint コマンドレットを使用してブレークポイントを取得します。 次に、パイプライン演算子 (|) を使用してブレークポイントを Remove-PSBreakpoint コマンドレットに送信し、それらを削除します。

例 5: 実行空間内のブレークポイントを削除する

この例では、ジョブが開始され、Set-PSBreakPoint の実行時に中断するようにブレークポイントが設定されます。 実行空間は変数に格納され、Runspace パラメーターを使用して Get-PSBreakPoint コマンドに渡されます。 Get-PSBreakPointの出力は、Remove-PSBreakpointにパイプ処理され、実行空間内のブレークポイントが削除されます。

Start-Job -ScriptBlock {
    Set-PSBreakpoint -Command Start-Sleep
    Start-Sleep -Seconds 10
}

$runspace = Get-Runspace -Id 1

Get-PSBreakPoint -Runspace $runspace | Remove-Breakpoint -Runspace $runspace

パラメーター

-Breakpoint

削除するブレークポイントを指定します。 ブレークポイント オブジェクトを含む変数、またはブレークポイント オブジェクトを取得するコマンド ( Get-PSBreakpoint コマンドなど) を入力します。 ブレークポイント オブジェクトをパイプして Remove-PSBreakpointすることもできます。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-Id

このコマンドレットがブレークポイントを削除するブレークポイント ID を指定します。

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

-Runspace

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

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

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

Breakpoint[]

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

Int32[]

Runspace

出力

None

このコマンドレットは、出力を返しません。

メモ

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

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