次の方法で共有

Wait-Debugger

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

スクリプトで次のステートメントを実行する前に、デバッガーのスクリプトを停止します。

構文

Wait-Debugger []

説明

Wait-Debugger コマンドレットの直後の時点で PowerShell スクリプト実行エンジンを停止し、デバッガーがアタッチされるのを待機します。

注意事項

完了したら、必ず Wait-Debugger 行を削除してください。 実行中のスクリプトは、 Wait-Debuggerで停止するとハングしているように見えます。

PowerShell でのデバッグの詳細については、「 about_Debuggers」を参照してください。

例

例 1: デバッグ用にブレークポイントを挿入する

ファイル dbgtest.ps1 には、関数 Test-Conditionが含まれています。 Wait-Debugger コマンドが関数に挿入され、その時点でスクリプトの実行が停止されました。 関数を実行すると、スクリプトは Wait-Debugger 行で停止し、コマンド ライン デバッガーに入ります。 l コマンドはスクリプト行を一覧表示し、他のデバッガー コマンドを使用してスクリプトの状態を調べることができます。

function Test-Condition {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory)]
        [string]$Name,
        [string]$Message = "Hello, $Name!"
    )

    if ($Name -eq $env:USERNAME) {
        Write-Output "$Message"
    } else {
        # Remove after debugging
        Wait-Debugger

        Write-Output "$Name is not the current user."
    }
}

PS D:\> Test-Condition Fred
Entering debug mode. Use h or ? for help.

At D:\temp\test\dbgtest.ps1:13 char:9
+         Wait-Debugger
+         ~~~~~~~~~~~~~
[DBG]: PS D:\>> l

    8:
    9:      if ($Name -eq $env:USERNAME) {
   10:          Write-Output "$Message"
   11:      } else {
   12:          # Remove after debugging
   13:*         Wait-Debugger
   14:
   15:          Write-Output "$Name is not the current user."
   16:      }
   17:  }

[DBG]: PS D:\>> $env:USERNAME
User01
[DBG]: PS D:\>> exit
PS D:\>

lからの出力は、スクリプトの実行が 13 行目のWait-Debuggerで停止していることを示していることに注意してください。

例 2: DSC リソースをデバッグするためのブレークポイントを挿入する

この例では、 Wait-Debugger コマンドが DSC リソースの CopyFile メソッドに挿入されています。 これは、DSC リソースで Enable-RunspaceDebug -BreakAll を使用するのと似ていますが、スクリプト内の特定の時点で中断します。

[DscResource()]
class FileResource
{
    [DscProperty(Key)]
    [string] $Path

    [DscProperty(Mandatory)]
    [Ensure] $Ensure

    [DscProperty(Mandatory)]
    [string] $SourcePath

    [DscProperty(NotConfigurable)]
    [Nullable[datetime]] $CreationTime


    [void] Set() {
        $fileExists = $this.TestFilePath($this.Path)
        if ($this.ensure -eq [Ensure]::Present) {
            if (! $fileExists) {
               $this.CopyFile()
            }
        } else {
            if ($fileExists) {
                Write-Verbose -Message "Deleting the file $($this.Path)"
                Remove-Item -LiteralPath $this.Path -Force
            }
        }
    }

    [bool] Test() {
        $present = Test-Path -LiteralPath $this.Path
        if ($this.Ensure -eq [Ensure]::Present) {
            return $present
        } else {
            return (! $present)
        }
    }

    [FileResource] Get() {
        $present = Test-Path -Path $this.Path
        if ($present) {
            $file = Get-ChildItem -LiteralPath $this.Path
            $this.CreationTime = $file.CreationTime
            $this.Ensure = [Ensure]::Present
        } else {
            $this.CreationTime = $null
            $this.Ensure = [Ensure]::Absent
        }
        return $this
    }

    [void] CopyFile() {
        # Testing only - Remove before deployment!
        Wait-Debugger

        if (! (Test-Path -LiteralPath $this.SourcePath)) {
            throw "SourcePath $($this.SourcePath) is not found."
        }
        if (Test-Path -LiteralPath $this.Path -PathType Container) {
            throw "Path $($this.Path) is a directory path"
        }
        Write-Verbose "Copying $($this.SourcePath) to $($this.Path)"
        Copy-Item -LiteralPath $this.SourcePath -Destination $this.Path -Force
    }
}

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

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