Write-Debug

Módulo:: Microsoft.PowerShell.Utility Module

Grava uma mensagem de depuração no console.

Sintaxe

Default (Predefinição)

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

Description

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

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 variável $DebugPreference. Primeiro, exibimos o valor atual de $DebugPreference e tentamos escrever uma mensagem de depuração. Em seguida, alteramos o valor de $DebugPreference para Continue, que permite que 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: Use 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 Debug 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 $DebugPreference muda 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.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Msg

Conjuntos de parâmetros

(All)

Position:	0
Obrigatório:	True
Valor do pipeline:	True
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	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.