Write-Debug

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Grava uma mensagem de depuração no console.

Syntax

Write-Debug
     [-Message] <String>
     [<CommonParameters>]

Description

O Write-Debug cmdlet grava mensagens de depuração no host a partir de um script ou comando.

Por padrão, as mensagens de depuração não são exibidas no console, mas você pode exibi-las usando o parâmetro Debug ou a $DebugPreference variável.

Exemplos

Exemplo 1: Compreender $DebugPreference

Este exemplo grava uma mensagem de depuração.

Write-Debug "Cannot open file."

O valor padrão de $DebugPreference é SilentlyContinue. Portanto, a mensagem não é exibida no console.

Exemplo 2: Alterar o valor de $DebugPreference

Este exemplo mostra o efeito de alterar o valor da $DebugPreference variável. Primeiro, exibimos o valor atual e tentamos escrever uma mensagem de $DebugPreference depuração. Em seguida, alteramos o valor de Continue, o que permite que as mensagens de $DebugPreference depuração sejam exibidas.

PS> $DebugPreference
SilentlyContinue
PS> Write-Debug "Cannot open file."
PS>
PS> $DebugPreference = "Continue"
PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.

Para obter mais informações sobre $DebugPreferenceo , consulte about_Preference_Variables.

Exemplo 3: Use o parâmetro Debug para substituir $DebugPreference

A Test-Debug função grava o valor da variável no host do PowerShell e no fluxo de $DebugPreference Depuração. Neste exemplo, usamos o parâmetro Debug para substituir o $DebugPreference valor.

function Test-Debug {
    [CmdletBinding()]
    param()
    Write-Debug ('$DebugPreference is ' + $DebugPreference)
    Write-Host ('$DebugPreference is ' + $DebugPreference)
}

PS> Test-Debug
$DebugPreference is SilentlyContinue

PS> Test-Debug -Debug
DEBUG: $DebugPreference is Continue
$DebugPreference is Continue
PS> $DebugPreference
SilentlyContinue

Observe que o valor das $DebugPreference alterações quando você usa o parâmetro Debug . Esta alteração afeta apenas o âmbito da função. O valor não é afetado fora da função.

Para obter mais informações sobre o parâmetro comum Debug , consulte about_CommonParameters.

Parâmetros

-Message

Especifica a mensagem de depuração a ser enviada ao console.

Type:String
Aliases:Msg
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Entradas

String

Você pode canalizar uma cadeia de caracteres que contém uma mensagem de depuração para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída. Ele só grava no fluxo de depuração.