Disable-PSBreakpoint
現在のコンソールのブレークポイントを無効にします。
構文
Disable-PSBreakpoint [-Id] <Int32[]> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-PSBreakpoint [-Breakpoint] <Breakpoint[]> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
説明
Disable-PSBreakpoint コマンドレットはブレークポイントを無効にするので、スクリプトの実行時にヒットしないようになります。これを使用すると、すべてのブレークポイントを無効にするか、ブレークポイント オブジェクトまたはブレークポイント ID を送信してブレークポイントを指定できます。
通常は、このコマンドレットによってブレークポイント オブジェクトの Enabled プロパティの値が False に変わります。ブレークポイントを再び有効にするには、Enable-PSBreakpoint コマンドレットを使用します。ブレークポイントは、Set-PSBreakpoint コマンドレットを使用して作成するとき、既定では有効になっています。
ブレークポイントは、スクリプト内の命令を調べることができるように実行が一時的に停止するスクリプトのポイントです。Disable-PSBreakpoint は、Windows PowerShell スクリプトのデバッグ用に設計された複数あるコマンドレットの 1 つです。Windows PowerShell デバッガーの詳細については、「about_Debuggers」を参照してください。
パラメーター
-Breakpoint <Breakpoint[]>
ブレークポイントが無効になるように指定します。ブレークポイント オブジェクトが含まれている変数か、Get-PSBreakpoint コマンドのようにブレークポイント オブジェクトを取得するコマンドを入力します。ブレークポイント オブジェクトを Disable-PSBreakpoint コマンドレットにパイプすることもできます。
必須 |
true |
位置 |
1 |
既定値 |
なし |
パイプライン入力を許可する |
true (ByValue) |
ワイルドカード文字を許可する |
false |
-Id <Int32[]>
指定したブレークポイント ID のブレークポイントを無効にします。ID を入力するか、ID が含まれている変数を入力します。ID を Disable-PSBreakpoint にパイプすることはできません。
必須 |
true |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
true (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-PassThru
有効にしたブレークポイントを表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
必須 |
false |
位置 |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
System.Management.Automation.Breakpoint ブレークポイント オブジェクトを Disable-PSBreakpoint にパイプできます。 |
出力 |
なし、または System.Management.Automation.Breakpoint PassThru パラメーターを使用した場合、Disable-PSBreakpoint は、無効になったブレークポイントを表すオブジェクトを返します。それ以外の場合、このコマンドレットによる出力はありません。 |
例 1
C:\PS>$b = set-psbreakpoint -script sample.ps1 -variable name
C:\PS> $b | disable-psbreakpoint
説明
-----------
これらのコマンドは、新しく作成したブレークポイントを無効にします。
最初のコマンドは、Set-PSBreakpoint コマンドレットを使用して、Sample.ps1 スクリプトの Name 変数にブレークポイントを作成します。次に、そのブレークポイント オブジェクトを $b 変数に保存します。
2 番目のコマンドは、Disable-PSBreakpoint コマンドレットを使用して、新しいブレークポイントを無効にします。また、パイプライン演算子 (|) を使用して、$b のブレークポイント オブジェクトを Disable-PSBreakpoint コマンドレットに送信します。
このコマンドの結果、$b のブレークポイント オブジェクトの Enabled プロパティの値が False になります。
例 2
C:\PS>disable-psbreakpoint -id 0
説明
-----------
このコマンドは、ブレークポイント ID が 0 のブレークポイントを無効にします。
例 3
C:\PS>disable-psbreakpoint -breakpoint ($b = set-psbreakpoint -script sample.ps1 -line 5)
C:\PS> $b
説明
-----------
このコマンドによって新しいブレークポイントが作成されますが、有効にするまでは無効のままです。
また、Disable-PSBreakpoint コマンドレットを使用してブレークポイントを無効にします。Breakpoint パラメーターの値は Set-PSBreakpoint コマンドです。このコマンドは新しいブレークポイントを作成し、ブレークポイント オブジェクトを生成して、そのオブジェクトを $b 変数に保存します。
値としてオブジェクトを使用する Cmdlet パラメーターは、オブジェクトを含んでいる変数か、オブジェクトを取得または生成するコマンドを受け入れることができます。この場合、Set-PSBreakpoint はブレークポイント オブジェクトを生成するため、Breakpoint パラメーターの値として使用できます。
2 番目のコマンドは、$b 変数の値にブレークポイント オブジェクトを表示します。
例 4
C:\PS>get-psbreakpoint | disable-psbreakpoint
説明
-----------
このコマンドは、現在のコンソールのブレークポイントをすべて無効にします。このコマンドは「gbp | dbp」と短縮することができます。
関連項目
概念
about_Debuggers
Set-PSBreakpoint
Get-PSBreakpoint
Enable-PSBreakpoint
Remove-PSBreakpoint
Get-PSCallStack