Share via

Disable-PSBreakpoint

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

現在のコンソール内のブレークポイントを無効にします。

構文

Disable-PSBreakpoint
       [-PassThru]
       [-Breakpoint] <Breakpoint[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-PSBreakpoint
       [-PassThru]
       [-Id] <Int32[]>
       [-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: 無効なブレークポイントをCreateする

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

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

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

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

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

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

`Get-PSBreakpoint` | Disable-PSBreakpoint

パラメーター

-Breakpoint

無効にするブレークポイントを指定します。 ブレークポイント オブジェクトを含む変数、またはブレークポイント オブジェクトを取得するコマンド (コマンドなど) を Get-PSBreakpoint 入力します。 ブレークポイント オブジェクトを コマンドレットに Disable-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 を持つブレークポイントを無効にします。 ID または ID が含まれる変数を入力します ID を に Disable-PSBreakpointパイプすることはできません。

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

-PassThru

有効になっているブレークポイントを表すオブジェクトが返されます。 既定では、このコマンドレットによる出力はありません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

ブレークポイント オブジェクトを に Disable-PSBreakpointパイプできます。

出力

None or System.Management.Automation.Breakpoint

PassThru パラメーターを使用すると、Disable-PSBreakpoint無効なブレークポイントを表す オブジェクトが返されます。 それ以外の場合、このコマンドレットによる出力はありません。