Disable-PSBreakpoint
現在のコンソールのブレークポイントを無効にします。
構文
Disable-PSBreakpoint
[-PassThru]
[-Breakpoint] <Breakpoint[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Disable-PSBreakpoint
[-PassThru]
[-Id] <Int32[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]説明
Disable-PSBreakpoint コマンドレットはブレークポイントを無効にし、スクリプトの実行時にブレークポイントがヒットしないようにします。 これを使用してすべてのブレークポイントを無効にすることも、ブレークポイント オブジェクトまたはブレークポイント ID を送信してブレークポイントを指定することもできます。
技術的には、このコマンドレットはブレークポイント オブジェクトの Enabled プロパティの値を False に変更します。 ブレークポイントを再度有効にするには、Enable-PSBreakpoint コマンドレットを使用します。 ブレークポイントは、Set-PSBreakpoint コマンドレットを使用してブレークポイントを作成するときに既定で有効になります。
ブレークポイントは、スクリプト内の命令を調べることができるように、実行が一時的に停止するスクリプト内のポイントです。 Disable-PSBreakpoint は、Windows PowerShell スクリプトのデバッグ用に設計されたいくつかのコマンドレットの 1 つです。 Windows PowerShell デバッガーの詳細については、「about_Debuggers」を参照してください。
例
例 1: ブレークポイントを設定して無効にする
PS C:\> $B = Set-PSBreakpoint -Script "sample.ps1" -Variable "name"
PS C:\> $B | Disable-PSBreakpointこれらのコマンドは、新しく作成されたブレークポイントを無効にします。
最初のコマンドでは、Set-PSBreakpoint コマンドレットを使用して、Sample.ps1 スクリプトの Name 変数にブレークポイントを作成します。 次に、ブレークポイント オブジェクトを $B 変数に保存します。
2 番目のコマンドでは、 Disable-PSBreakpoint コマンドレットを使用して、新しいブレークポイントを無効にします。 パイプライン演算子 (|) を使用して、$B 内のブレークポイント オブジェクトを Disable-PSBreakpoint コマンドレットに送信します。
このコマンドの結果、$B のブレークポイント オブジェクトの Enabled プロパティの値は False になります。
例 2: ブレークポイントを無効にする
PS C:\> Disable-PSBreakpoint -Id 0このコマンドは、ブレークポイント ID が 0 のブレークポイントを無効にします。
例 3: 無効なブレークポイントを作成する
PS C:\> Disable-PSBreakpoint -Breakpoint ($B = Set-PSBreakpoint -Script "sample.ps1" -Line 5)
PS C:\> $Bこのコマンドは、有効になるまで無効になっている新しいブレークポイントを作成します。
Disable-PSBreakpoint コマンドレットを使用して、ブレークポイントを無効にします。 Breakpoint パラメーターの値は、新しいブレークポイントを設定し、ブレークポイント オブジェクトを生成し、オブジェクトを $B 変数に保存する Set-PSBreakpoint コマンドです。
オブジェクトを値として受け取るコマンドレット パラメーターは、オブジェクトを含む変数、またはオブジェクトを取得または生成するコマンドを受け取ることができます。 この場合、 Set-PSBreakpoint はブレークポイント オブジェクトを生成するため、 Breakpoint パラメーターの値として使用できます。
2 番目のコマンドは、$B 変数の値にブレークポイント オブジェクトを表示します。
例 4: 現在のコンソールのすべてのブレークポイントを無効にする
PS C:\> Get-PSBreakpoint | Disable-PSBreakpointこのコマンドは、現在のコンソール内のすべてのブレークポイントを無効にします。 このコマンドは次のように省略できます: "gbp |dbp"。
パラメーター
-Breakpoint
無効にするブレークポイントを指定します。 ブレークポイント オブジェクトを含む変数、またはブレークポイント オブジェクトを取得するコマンド (Get-PSBreakpoint コマンドなど) を入力します。 ブレークポイント オブジェクトを Disable-PSBreakpoint コマンドレットにパイプ処理することもできます。
| 型: | Breakpoint[] |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Id
ブレークポイント ID を含む ID または変数の配列を指定します。 ID を Disable-PSBreakpoint にパイプすることはできません。
| 型: | Int32[] |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PassThru
作業中のアイテムを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
ブレークポイント オブジェクトを Disable-PSBreakpoint にパイプ処理できます。
出力
None or System.Management.Automation.Breakpoint
PassThru パラメーターを使用すると、Disable-PSBreakpoint は無効なブレークポイントを表すオブジェクトを返します。 それ以外の場合、このコマンドレットは出力を生成しません。