Wait-Debugger
Zatrzymuje skrypt w debugerze przed uruchomieniem następnej instrukcji w skrycie.
Składnia
Wait-Debugger []
Opis
Zatrzymuje aparat wykonywania skryptów programu PowerShell natychmiast po poleceniu Wait-Debugger
cmdlet i czeka na dołączenie debugera.
Uwaga
Pamiętaj, aby usunąć wiersze po zakończeniu Wait-Debugger
. Wydaje się, że uruchomiony skrypt zawiesza się po zatrzymaniu w obiekcie Wait-Debugger
.
Aby uzyskać więcej informacji na temat debugowania w programie PowerShell, zobacz about_Debuggers.
Przykłady
Przykład 1. Wstawianie punktu przerwania na potrzeby debugowania
Plik dbgtest.ps1
zawiera funkcję Test-Condition
. Polecenie Wait-Debugger
zostało wstawione w funkcji w celu zatrzymania wykonywania skryptu w tym momencie. Po uruchomieniu funkcji skrypt zatrzymuje się w Wait-Debugger
wierszu i wprowadza debuger wiersza polecenia. Polecenie l
wyświetla listę wierszy skryptu i można użyć innych poleceń debugera do sprawdzenia stanu skryptu.
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:\>
Zwróć uwagę, że dane wyjściowe z programu l
pokazują, że wykonanie skryptu jest zatrzymywane w Wait-Debugger
wierszu 13.
Przykład 2. Wstawianie punktu przerwania na potrzeby debugowania zasobu DSC
W tym przykładzie Wait-Debugger
polecenie zostało wstawione w CopyFile
metodzie zasobu DSC. Jest to podobne do użycia Enable-RunspaceDebug -BreakAll
w zasobie DSC, ale przerywa działanie w określonym punkcie skryptu.
[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
}
}
Dane wejściowe
None
Nie można potokować obiektów do tego polecenia cmdlet.
Dane wyjściowe
None
To polecenie cmdlet nie zwraca żadnych danych wyjściowych.