Write-Host
Saída de gravações personalizadas em um host.
Sintaxe
Write-Host [[-Object] <Object>] [-BackgroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-ForegroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-NoNewline] [-Separator <Object>] [<CommonParameters>]
Descrição
O cmdlet Write-Host personaliza a saída. É possível especificar a cor do texto usando o parâmetro ForegroundColor e especificar a cor do plano de fundo da janela usando o parâmetro BackgroundColor. O parâmetro Separator permite que você especifique uma string a ser usada para separar os objetos exibidos. O resultado específico depende do programa que está hospedando o Windows PowerShell.
Parâmetros
-BackgroundColor <ConsoleColor>
Especifica a cor do plano de fundo. Não há um padrão.
| Necessário? | false |
| Posição? | named |
| Valor padrão | nenhum |
| Aceitar entrada do pipeline? | false |
| Aceitar caracteres curinga? | false |
-ForegroundColor <ConsoleColor>
Especifica a cor do texto. Não há um padrão.
| Necessário? | false |
| Posição? | named |
| Valor padrão | nenhum |
| Aceitar entrada do pipeline? | false |
| Aceitar caracteres curinga? | false |
-NoNewline
Especifica que o conteúdo exibido no console não é finalizado com um caractere de nova linha.
| Necessário? | false |
| Posição? | named |
| Valor padrão | nenhum |
| Aceitar entrada do pipeline? | false |
| Aceitar caracteres curinga? | false |
-Object <Object>
Objetos a serem exibidos no console.
| Necessário? | false |
| Posição? | 1 |
| Valor padrão | nenhum |
| Aceitar entrada do pipeline? | true (ByValue) |
| Aceitar caracteres curinga? | false |
-Separator <Object>
Cadeia de caracteres para a saída entre objetos exibidos no console.
| Necessário? | false |
| Posição? | named |
| Valor padrão | nenhum |
| Aceitar entrada do pipeline? | false |
| 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.Object
Você pode canalizar objetos a serem gravados no host. |
| Saídas | None
Write-Host envia os objetos para o host. Ele não retorna objetos. Porém, o host poderia exibir os objetos que Write-Host envia para ele. |
Exemplo 1
C:\PS>write-host "no newline test " -nonewline no newline test C:\PS> Descrição ----------- Esse comando exibe a entrada no console, mas por causa do parâmetro NoNewline, a saída é seguida diretamente pelo prompt.
Exemplo 2
C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= " 2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12 Descrição ----------- Este comando exibe os números pares de 2 a 12. O parâmetro Separator é usado para adicionar a string, +2= (vírgula, espaço, +, 2, =, espaço).
Exemplo 3
C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white Descrição ----------- Esse comando exibe os números pares de 2 a 12. Ele usa o parâmetro ForegroundColor para o texto em verde-escuro da saída e o parâmetro BackgroundColor para exibir um plano de fundo em branco.
Exemplo 4
C:\PS>write-host "Red on white text." -ForegroundColor red -BackgroundColor white Red on white text. Descrição ----------- Esse comando exibe a string "Vermelho em texto branco". O texto é vermelho, conforme definido pelo parâmetro ForegroundColor. O plano de fundo é branco, conforme definido pelo parâmetro BackgroundColor.