Grava uma mensagem de aviso.
Sintaxe
Write-Warning [-Message] <string> [<CommonParameters>]
Descrição
O cmdlet Write-Warning grava uma mensagem de aviso no host do Windows PowerShell. A resposta ao aviso depende do valor da variável $WarningPreference do usuário e do uso do parâmetro comum WarningAction.
Parâmetros
-Message <string>
Especifica a mensagem de aviso.
|
Necessário? |
true |
|
Posição? |
1 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
true (ByValue) |
|
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
|
Entradas |
System.String Você pode canalizar uma cadeia de caracteres que contém o aviso para Write-Warning. |
|
Saídas |
None Write-Warning só grava no fluxo de aviso. Ela não gera qualquer outra saída. |
Observações
O valor padrão da variável $WarningPreference é "Continue" que exibe o aviso e continua a executar o comando. Para determinar os valores válidos de uma variável de preferência, como $WarningPreference, defina-a como uma cadeia de caracteres aleatórios, como “abc”. A mensagem de erro resultante será uma lista de valores válidos.
Exemplo 1
C:\PS>write-warning "This is only a test warning." Descrição ----------- Esse comando exibe a mensagem "WARNING: Este é apenas um aviso de teste".
Exemplo 2
C:\PS>$w = "This is only a test warning." C:\PS> $w | write-warning Descrição ----------- Esse exemplo mostra que é possível usar um operador de pipeline (|) para enviar uma cadeia de caracteres para Write-Warning. É possível salvar a cadeia de caracteres em uma variável, conforme mostrado nesse comando, ou canalizar a cadeia de caracteres diretamente para Write-Warning.
Exemplo 3
C:\PS>$warningpreference Continue C:\PS> write-warning "This is only a test warning." This is only a test warning. C:\PS> $warningpreference = "SilentlyContinue" C:\PS> write-warning "This is only a test warning." C:\PS> C:\PS> $warningpreference = "Stop" C:\PS> write-warning "This is only a test warning." WARNING: This is only a test message. Write-Warning : Command execution stopped because the shell variable "WarningPreference" is set to Stop. At line:1 char:14 + write-warning <<<< "This is only a test message." Descrição ----------- Esse exemplo mostra o efeito do valor da variável $WarningPreference em um comando Write-Warning. O primeiro comando exibe o valor padrão da variável $WarningPreference, que é "Continue". Como resultado, quando você escrever um aviso, a mensagem de aviso será exibida e a execução continuará. Quando você altera o valor da variável $WarningPreference, o efeito do comando Write-Warning é alterado novamente. Um valor de "SilentlyContinue" suprime o aviso. Um valor de "Stop" exibe o aviso e interrompe a execução do comando. Para obter mais informações sobre a variável $WarningPreference, consulte about_Preference_Variables.
Exemplo 4
C:\PS>write-warning "This is only a test warning." -warningaction Inquire WARNING: This is only a test warning. Confirm Continue with this operation? [Y] Yes [A] Yes to All [H] Halt Command [S] Suspend [?] Help (default is "Y"): Descrição ----------- Esse exemplo mostra o efeito do parâmetro comum WarningAction em um comando Write-Warning. É possível usar o parâmetro comum WarningAction com qualquer cmdlet para determinar como o Windows PowerShell responde a avisos resultantes desse comando. O parâmetro comum WarningAction substitui o valor de $WarningPreference apenas para aquele comando específico. Esse comando usa o cmdlet Write-Warning para exibir um aviso. O parâmetro comum WarningAction com um valor de "Inquire" direciona o sistema para avisar o usuário quando o comando exibe um aviso. Para obter mais informações sobre o parâmetro comum WarningAction, consulte about_CommonParameters.
See Also