Compartir a través de

Write-Host

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Escribe resultados personalizados en un host.

Syntax

Write-Host
     [[-Object] <Object>]
     [-NoNewline]
     [-Separator <Object>]
     [-ForegroundColor <ConsoleColor>]
     [-BackgroundColor <ConsoleColor>]
     [<CommonParameters>]

Description

El Write-Host cmdlet personaliza la salida. Puede especificar el color del texto mediante el ForegroundColor parámetro y puede especificar el color de fondo mediante el BackgroundColor parámetro . El parámetro Separator permite especificar una cadena con la que separar los objetos mostrados. El resultado concreto depende del programa que hospeda PowerShell.

Nota

A partir de Windows PowerShell 5.0, Write-Host es un contenedor para Write-Information Esto permite usar Write-Host para emitir la salida al flujo de información. Esto permite la captura o supresión de los datos escritos mediante Write-Host , a la vez que se conserva la compatibilidad con versiones anteriores.

La $InformationPreference variable de preferencia y InformationAction el parámetro común no afectan a los Write-Host mensajes. La excepción a esta regla es -InformationAction Ignore, que suprime eficazmente la Write-Host salida. (vea "Ejemplo 5")

Ejemplos

Ejemplo 1: Escribir en la consola sin agregar una nueva línea

Write-Host "no newline test " -NoNewline
Write-Host "second string"

no newline test second string

Este comando muestra la cadena "no newline test" con el NoNewline parámetro .

Se escribe una segunda cadena, pero termina en la misma línea que la primera debido a la ausencia de una nueva línea que separa las cadenas.

Ejemplo 2: Escribir en la consola e incluir un separador

Write-Host (2,4,6,8,10,12) -Separator ", +2= "

2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12

Este comando muestra los números pares de dos a doce. El parámetro Separator se usa para agregar la cadena , +2= (comma, space, +, 2, =, space).

Ejemplo 3: Escribir con diferentes colores de texto y fondo

Write-Host (2,4,6,8,10,12) -Separator ", -> " -ForegroundColor DarkGreen -BackgroundColor White

2, -> 4, -> 6, -> 8, -> 10, -> 12

Este comando muestra los números pares de dos a doce. Usa el ForegroundColor parámetro para generar texto "verde oscuro" y el BackgroundColor parámetro para mostrar un fondo "blanco".

Ejemplo 4: Escritura con diferentes colores de texto y fondo

Write-Host "Red on white text." -ForegroundColor red -BackgroundColor white

Red on white text.

Este comando muestra la cadena "Rojo en texto blanco". El texto es "rojo", tal como se define en el ForegroundColor parámetro . El fondo es "blanco", tal como se define en el BackgroundColor parámetro .

Ejemplo 5: Suprimir la salida de Write-Host

# The following two statements can be used to effectively suppress output from Write-Host
Write-Host "I won't print" -InformationAction Ignore
Write-Host "I won't print" 6>$null

Este comando muestra la cadena "Rojo en texto blanco". El texto es "rojo", tal como se define en el ForegroundColor parámetro . El fondo es "blanco", tal como se define en el BackgroundColor parámetro .

Parámetros

-BackgroundColor

Especifica el color de fondo. No tiene ningún valor predeterminado. Los valores permitidos para este parámetro son los siguientes:

  • Negro
  • Azul oscuro
  • Verde oscuro
  • Cian oscuro
  • Rojo oscuro
  • Magenta oscuro
  • Amarillo oscuro
  • Gris
  • Gris oscuro
  • Azul
  • Verde
  • Cian
  • Rojo
  • Fucsia
  • Amarillo
  • Blanco
Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForegroundColor

Especifica el color del texto. No tiene ningún valor predeterminado. Los valores permitidos para este parámetro son los siguientes:

  • Negro
  • Azul oscuro
  • Verde oscuro
  • Cian oscuro
  • Rojo oscuro
  • Magenta oscuro
  • Amarillo oscuro
  • Gris
  • Gris oscuro
  • Azul
  • Verde
  • Cian
  • Rojo
  • Fucsia
  • Amarillo
  • Blanco
Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoNewline

Las representaciones de cadena de los objetos de entrada se concatenan para formar la salida. No se insertan espacios ni nuevas líneas entre las cadenas de salida. No se agrega ninguna nueva línea después de la última cadena de salida.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Object

Objetos que se van a mostrar en el host.

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Separator

Especifica una cadena separadora que se va a insertar entre los objetos mostrados por el host.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

Object

Se pueden canalizar objetos para que se escriban en el host.

Salidas

None

Write-Host envía los objetos al host. No devuelve ningún objeto. Sin embargo, el host puede mostrar los objetos que Write-Host lo envían.