通过

Wait-Debugger

  • 参考
模块:
Microsoft.PowerShell.Utility

在运行脚本中的下一个语句之前，在调试器中停止脚本。

语法

Wait-Debugger []

说明

在 Wait-Debugger cmdlet 之后立即停止 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 已 CopyFile 插入 DSC 资源的方法中。 这类似于在 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

不能通过管道将对象传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。