Remove-PSBreakpoint

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

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

構文

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、スクリプト内の変数にブレークポイントを$NameSample.ps1作成し、ブレークポイント オブジェクトを変数に$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をパイプすることもできます。

Type:Breakpoint[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

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

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
Aliases:RunspaceId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

Breakpoint[]

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

Int32[]

Runspace

出力

None

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

メモ

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

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