Escribe una salida personalizada en un host.
Sintaxis
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>]
Descripción
El cmdlet Write-Host personaliza la salida. Puede especificar el color de texto mediante el parámetro ForegroundColor y 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 concreto depende del programa que hospede Windows PowerShell.
Parámetros
-BackgroundColor <ConsoleColor>
Especifica el color del fondo. No hay un color predeterminado.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
ninguno |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-ForegroundColor <ConsoleColor>
Especifica el color del texto. No hay un color predeterminado.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
ninguno |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-NoNewline
Establece que el contenido mostrado en la consola no finaliza con un carácter de nueva línea.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
ninguno |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Object <Object>
Objetos que se van a mostrar en la consola.
|
¿Requerido? |
false |
|
¿Posición? |
1 |
|
Valor predeterminado |
ninguno |
|
¿Aceptar canalización? |
true (ByValue) |
|
¿Aceptar caracteres comodín? |
false |
-Separator <Object>
Cadena que va a separar los objetos que se muestran en la consola.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
ninguno |
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
System.Object Puede canalizar al host los objetos que se van a escribir. |
|
Salidas |
Ninguno Write-Host envía los objetos al host. No devuelve ningún objeto. No obstante, el host podría mostrar los objetos que le envía Write-Host. |
Ejemplo 1
C:\PS>write-host "no newline test " -nonewline no newline test C:\PS> Descripción ----------- Este comando muestra la entrada en la consola, pero debido al parámetro NoNewline, la salida va seguida directamente por el mensaje.
Ejemplo 2
C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= " 2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12 Descripción ----------- Este comando muestra los números pares del 2 al 12. El parámetro Separator se usa para agregar la cadena , +2= (coma, espacio, +, 2, =, espacio).
Ejemplo 3
C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white Descripción ----------- Este comando muestra los números pares del 2 al 12. Usa el parámetro ForegroundColor para mostrar el texto en verde oscuro y el parámetro BackgroundColor para mostrar un fondo blanco.
Ejemplo 4
C:\PS>write-host "Red on white text." -ForegroundColor red -BackgroundColor white Red on white text. Descripción ----------- Este comando muestra la cadena "Red on white text". El texto es de color rojo, tal y como se define mediante el parámetro ForegroundColor. El fondo es blanco, tal y como se define mediante el parámetro BackgroundColor.
Vea también