Compartir a través de

Write-Host

Módulo:
Microsoft.PowerShell.Utility Module

Escribe la salida personalizada en un host.

Sintaxis

Default (valor predeterminado) 

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

Description

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

Nota:

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

La variable de preferencia $InformationPreference y InformationAction parámetro común no afectan a Write-Host mensajes. La excepción a esta regla es -InformationAction Ignore, que suprime eficazmente 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 parámetro NoNewline.

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: Escritura 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 parámetro ForegroundColor para generar texto "verde oscuro" y el parámetro BackgroundColor 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 parámetro ForegroundColor. El fondo es "blanco", tal como se define en el parámetro BackgroundColor.

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 parámetro ForegroundColor. El fondo es "blanco", tal como se define en el parámetro BackgroundColor.

Parámetros

-BackgroundColor

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

  • Negro
  • Azul oscuro
  • Verde oscuro
  • Cian oscuro
  • Rojo oscuro
  • Magenta oscuro
  • Amarillo oscuro
  • Gris
  • Gris oscuro
  • Azul
  • Verde
  • Cyan
  • Rojo
  • Magenta
  • Amarillo
  • Blanco

Propiedades de parámetro

Tipo:ConsoleColor
Valor predeterminado:None
Valores aceptados:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ForegroundColor

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

  • Negro
  • Azul oscuro
  • Verde oscuro
  • Cian oscuro
  • Rojo oscuro
  • Magenta oscuro
  • Amarillo oscuro
  • Gris
  • Gris oscuro
  • Azul
  • Verde
  • Cyan
  • Rojo
  • Magenta
  • Amarillo
  • Blanco

Propiedades de parámetro

Tipo:ConsoleColor
Valor predeterminado:None
Valores aceptados:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes: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.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Object

Objetos que se van a mostrar en el host.

Propiedades de parámetro

Tipo:Object
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Separator

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

Propiedades de parámetro

Tipo:Object
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

Object

Puede canalizar objetos que se van a escribir 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 los envía.