Compartilhar via

Write-Debug

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

Grava uma mensagem de depuração para o console.

Sintaxe

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

Description

O Write-Debug cmdlet grava mensagens de depuração no host 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: Entenda $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 para 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: Usar o parâmetro Debug para substituir $DebugPreference

A Test-Debug função grava o $DebugPreference valor da variável no host do PowerShell e no fluxo de 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 Inquire

Confirm
Continue with this operation?
[Y] Yes  [A] Yes to All  [H] Halt Command  [?] Help (default is "Y"):
$DebugPreference is Inquire
PS> $DebugPreference
SilentlyContinue

Observe que o valor de $DebugPreference muda quando você usa o parâmetro Debug . Essa alteração afeta apenas o escopo da função. O valor não é afetado fora da função.

Observação

Quando o valor de $DebugPreference é Inquire, o PowerShell interrompe a execução para perguntar se a execução deve continuar.

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

Parâmetros

-Message

Especifica a mensagem de depuração para enviar para o console.

Tipo:String
Aliases:Msg
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

String

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

Saídas

None

Esse cmdlet não retorna nenhuma saída. Ele grava apenas no fluxo de depuração.