Condividi tramite

Write-Host

Modulo:
Microsoft.PowerShell.Utility Module

Scrive l'output personalizzato in un host.

Sintassi

Default (Impostazione predefinita) 

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

Descrizione

Il cmdlet Write-Host personalizza l'output. È possibile specificare il colore del testo usando il parametro ForegroundColor ed è possibile specificare il colore di sfondo usando il parametro BackgroundColor. Il parametro Separator consente di specificare una stringa da utilizzare per separare gli oggetti visualizzati. Il risultato specifico dipende dal programma che ospita PowerShell.

Annotazioni

A partire da Windows PowerShell 5.0, Write-Host è un wrapper per Write-Information. Questo consente di usare Write-Host per emettere output nel flusso di informazioni. In questo modo, l'acquisizione di o l'eliminazione di di dati scritti usando Write-Host mantenendo al tempo stesso la compatibilità con le versioni precedenti.

La variabile di preferenza $InformationPreference e InformationAction parametro comune non influiscono sui messaggi Write-Host. L'eccezione a questa regola è -InformationAction Ignore, che elimina in modo efficace Write-Host output. (vedere "Esempio 5")

Esempio

Esempio 1: Scrivere nella console senza aggiungere una nuova riga

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

no newline test second string

Questo comando visualizza la stringa 'no newline test' con il parametro NoNewline.

Viene scritta una seconda stringa, ma termina sulla stessa riga della prima a causa dell'assenza di una nuova riga che separa le stringhe.

Esempio 2: Scrivere nella console e includere un separatore

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

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

Questo comando visualizza i numeri pari da due a dodici. Il parametro Separator viene usato per aggiungere la stringa , +2= (comma, space, +, 2, =, space).

Esempio 3: Scrivere con testo e colori di sfondo diversi

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

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

Questo comando visualizza i numeri pari da due a dodici. Usa il parametro ForegroundColor per restituire il testo "verde scuro" e il parametro BackgroundColor per visualizzare uno sfondo "bianco".

Esempio 4: Scrivere con testo e colori di sfondo diversi

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

Red on white text.

Questo comando visualizza la stringa "Red on white text". Il testo è "rosso", come definito dal parametro ForegroundColor. Lo sfondo è "bianco", come definito dal parametro BackgroundColor.

Esempio 5: Eliminare l'output da 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

Questo comando visualizza la stringa "Red on white text". Il testo è "rosso", come definito dal parametro ForegroundColor. Lo sfondo è "bianco", come definito dal parametro BackgroundColor.

Parametri

-BackgroundColor

Specifica il colore di sfondo. Non c'è nessun predefinito. I valori accettabili per questo parametro sono:

  • Nero
  • Blu scuro
  • Verde scuro
  • Ciano scuro
  • Rosso scuro
  • Magenta scuro
  • Giallo scuro
  • Grigio
  • Grigio scuro
  • Blu
  • Verde
  • Ciano
  • Rosso
  • Magenta
  • Giallo
  • Bianco

Proprietà dei parametri

Tipo:ConsoleColor
Valore predefinito:None
Valori accettati:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ForegroundColor

Specifica il colore del testo. Non c'è nessun predefinito. I valori accettabili per questo parametro sono:

  • Nero
  • Blu scuro
  • Verde scuro
  • Ciano scuro
  • Rosso scuro
  • Magenta scuro
  • Giallo scuro
  • Grigio
  • Grigio scuro
  • Blu
  • Verde
  • Ciano
  • Rosso
  • Magenta
  • Giallo
  • Bianco

Proprietà dei parametri

Tipo:ConsoleColor
Valore predefinito:None
Valori accettati:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-NoNewline

Le rappresentazioni di stringa degli oggetti di input vengono concatenate per formare l'output. Non vengono inseriti spazi o nuove righe tra le stringhe di output. Nessuna nuova riga viene aggiunta dopo l'ultima stringa di output.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Object

Oggetti da visualizzare nell'host.

Proprietà dei parametri

Tipo:Object
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:0
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Separator

Specifica una stringa separatore da inserire tra gli oggetti visualizzati dall'host.

Proprietà dei parametri

Tipo:Object
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

Object

È possibile inviare tramite pipe gli oggetti da scrivere nell'host.

Output

None

Write-Host invia gli oggetti all'host. Non restituisce alcun oggetto. Tuttavia, l'host potrebbe visualizzare gli oggetti che Write-Host inviati.