Compartilhar via

Write-Debug

Módulo:
Microsoft.PowerShell.Utility Module

Grava uma mensagem de depuração no console.

Sintaxe

Default (Padrão) 

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

Description

O cmdlet Write-Debug 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 Depurar ou a variável $DebugPreference.

Exemplos

Exemplo 1: Entender $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 variável $DebugPreference. Primeiro, exibimos o valor atual de $DebugPreference e tentamos gravar uma mensagem de depuração. Em seguida, alteramos o valor de $DebugPreference para Continuar, o que permite que as mensagens de 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 $DebugPreference, consulte about_Preference_Variables.

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

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

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 de é alterado quando você usa o parâmetro de depuração . Essa alteração afeta apenas o escopo da função. O valor não é afetado fora da função.

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

Parâmetros

-Message

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Msg

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

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

Saídas

None

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