escribe la salida personalizada en un host.
sintaxis
Descripción
el objetivo principal del cmdlet Write-Host
es producir una salida solo para visualización(host), como imprimir texto en color, como cuando se solicita al usuario la entrada junto con Read-Host.Write-Host
usa el método ToString () para escribir la salida., Por el contrario, para enviar datos a la canalización, utilice Write-Output o implicitoutput.
Puede especificar el color del texto utilizando el parámetro ForegroundColor
, y puede especificar el color de fondo de fondo utilizando el parámetro BackgroundColor
. El parámetro separador le permite especificar una cadena para separar los objetos mostrados. El resultado concreto depende del programa que aloja PowerShell.
Nota
a partir de Windows PowerShell 5.,0, Write-Host
es un contenedor Write-Information
Esta allowsyou usar Write-Host
emiten de salida para la transmisión de información. Esto permite capturar osuppression de datos escritos usando Write-Host
mientras se preserva la compatibilidad con versiones anteriores.
la variable de preferencia $InformationPreference
y el parámetro común InformationAction
no afectan a los mensajes Write-Host
. La excepción a esta regla es -InformationAction Ignore
, que suprime eficazmente la salida Write-Host
., (ver «Ejemplo 5»)
ejemplos
ejemplo 1: escribir en la consola sin añadir una nueva línea
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 separe las cadenas.,
Ejemplo 2: Escribir en la consola e incluir un separador
Ejemplo 3: Escribir con diferentes colores de texto y fondo
Este comando muestra los números pares del dos al doce. Utiliza el parámetro ForegroundColor
para generar texto verde oscuro y el parámetro BackgroundColor
para mostrar un fondo blanco.
Ejemplo 4: Escribir con diferentes colores de texto y fondo
Este comando muestra la cadena » rojo sobre texto blanco.,»El texto es Rojo, como se define por el parámetroForegroundColor
. El fondo es blanco, definido por el parámetro BackgroundColor
.
ejemplo 5: suprimir la salida del host de escritura
estos comandos suprimen efectivamente la salida del cmdlet Write-Host
. El primero utiliza el parámetroInformationAction
con el valor Ignore
para suprimir la salida al flujo de información.,El segundo ejemplo redirige el flujo de información del comando a la variable $null
y por lo tanto la suprime.
Parámetros
Especifica el color de fondo. No hay ningún valor predeterminado.,ellow
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the text color., No hay ningún valor predeterminado.,
The string representations of the input objects are concatenated to form the output., No se insertan espacios ni líneas entre las cadenas de salida. No se añade una nueva línea después de la última cadena de salida.
Tipo: | SwitchParameter |
Cargo: | Nombre |
valor Predeterminado: | Ninguno |
Aceptar tubería de entrada: | False |
Aceptar caracteres comodín: | False |
Objetos para mostrar en el host.,
Type: | Object |
Aliases: | Msg, Message |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies a separator string to insert between objects displayed by the host.,
Type: | Object |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Object
You can pipe objects to be written to the host.
Outputs
None
Write-Host
sends the objects to the host. It does not return any objects., Sin embargo, el hostmuestra los objetos que Write-Host
le envía.
notas
-
al escribir una colección en el host, los elementos de la colección se imprimen en la misma línea separados por un único espacio. Esto se puede sobrescribir con el parámetro Separator.
-
los tipos de datos no primitivos, como los objetos con propiedades, pueden causar resultados inesperados y no proporcionar resultados significativos. Por ejemplo,
Write-Host @{a = 1; b = 2}
imprimiráSystem.Collections.DictionaryEntry System.Collections.DictionaryEntry
en el host.,
- Claro-Host
- Out-Host
- Escribir-Debug
- Write-Error
- Write-Output
- Escribir-el Progreso
- Write-Verbose
- Escribir-Warning