Disable-PSBreakpoint

構文

Disable-PSBreakpoint
       [-PassThru]
       [-Breakpoint] <Breakpoint[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Disable-PSBreakpoint
       [-PassThru]
       [-Id] <Int32[]>
       [-Runspace <Runspace>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

Disable-PSBreakpoint コマンドレットはブレークポイントを無効にし、スクリプトの実行時にヒットしないことを保証します。 これを使用してすべてのブレークポイントを無効にするか、ブレークポイント オブジェクト ID またはブレークポイント ID を送信してブレークポイントを指定することができます。

技術的には、このコマンドレットを使用して、ブレークポイントのオブジェクトの Enabled プロパティの値を False に変更します。 ブレークポイントを再度有効にするには、 Enable-PSBreakpoint コマンドレットを使用します。 ブレークポイントは、 Set-PSBreakpoint コマンドレットを使用してブレークポイントを作成するときに既定で有効になります。

ブレークポイントは、スクリプト内の指示を調べることができるように、実行を一時的に停止するスクリプト内のポイントです。 Disable-PSBreakpoint は、PowerShell スクリプトのデバッグ用に設計されたいくつかのコマンドレットの 1 つです。 PowerShell デバッガーの詳細については、「 about_Debuggers」を参照してください。

例

例 1: ブレークポイントを設定して無効にする

これらのコマンドは、新しく作成したブレークポイントを無効にします。

$B = Set-PSBreakpoint -Script "sample.ps1" -Variable "name"
$B | Disable-PSBreakpoint

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

このコマンドの結果として、$Bのブレークポイント オブジェクトの Enabled プロパティの値はFalse。

例 2: ブレークポイントを無効にする

このコマンドは、ブレークポイント ID が 0 のブレークポイントを無効にします。

Disable-PSBreakpoint -Id 0

例 3: 無効なブレークポイントを作成する

このコマンドは、有効に設定するまで無効である新しいブレークポイントを作成します。

Disable-PSBreakpoint -Breakpoint ($B = Set-PSBreakpoint -Script "sample.ps1" -Line 5)

Disable-PSBreakpoint コマンドレットを使用してブレークポイントを無効にします。 Breakpoint パラメーターの値は、新しいブレークポイントを設定し、ブレークポイント オブジェクトを生成し、オブジェクトを$B変数に保存するSet-PSBreakpoint コマンドです。

オブジェクトを値として受け取るコマンドレットのパラメーターは、オブジェクトを含む変数や、オブジェクトを取得または生成するコマンドを受け取ることができます。 この場合、ブレークポイント オブジェクト Set-PSBreakpoint 生成されるため、 Breakpoint パラメーターの値として使用できます。

例 4: 現在のコンソールのすべてのブレークポイントを無効にする

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

`Get-PSBreakpoint` | Disable-PSBreakpoint

例 5: 実行空間でブレークポイントを無効にする

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

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

$runspace = Get-Runspace -Id 1

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

パラメーター

-Breakpoint

-Confirm

-Id

-PassThru

-Runspace

-WhatIf

入力

Breakpoint

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

出力

None

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

Breakpoint

PassThru パラメーターを使用すると、このコマンドレットは無効なブレークポイントを表すブレークポイント オブジェクトを返します。

メモ

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

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

関連リンク

• Enable-PSBreakpoint
• Get-PSBreakpoint
• Get-PSCallStack
• Remove-PSBreakpoint
• Set-PSBreakpoint