Partager via

Wait-Debugger

Module:
Microsoft.PowerShell.Utility Module

Arrête un script dans le débogueur avant d’exécuter l’instruction suivante dans le script.

Syntaxe

Default (Par défaut) 

Wait-Debugger

Description

Arrête le moteur d’exécution de script PowerShell au point immédiatement après le cmdlet Wait-Debugger et attend qu’un débogueur soit attaché.

Avertissement

Veillez à supprimer les lignes Wait-Debugger une fois que vous avez terminé. Un script en cours d’exécution semble bloqué lorsqu’il est arrêté à un Wait-Debugger.

Pour plus d’informations sur le débogage dans PowerShell, consultez about_Debuggers.

Exemples

Exemple 1 : Insérer un point d’arrêt pour le débogage

Le fichier dbgtest.ps1 contient une fonction Test-Condition. La commande Wait-Debugger a été insérée dans la fonction pour arrêter l’exécution du script à ce stade. Lorsque vous exécutez la fonction, le script s’arrête à la ligne Wait-Debugger et entre dans le débogueur de ligne de commande. La commande l répertorie les lignes de script et vous pouvez utiliser d’autres commandes de débogueur pour inspecter l’état du script.

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:\>

Notez que la sortie du l indique que l’exécution du script est arrêtée à la Wait-Debugger à la ligne 13.

Exemple 2 : Insérer un point d’arrêt pour le débogage d’une ressource DSC

Dans cet exemple, la commande Wait-Debugger a été insérée dans la méthode CopyFile d’une ressource DSC. Cela est similaire à l’utilisation de Enable-RunspaceDebug -BreakAll dans une ressource DSC, mais s’arrête à un point spécifique dans le script.

[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
    }
}

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne aucune sortie.