Condividi tramite

Write-Host

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Scrive output personalizzato in un host.

Sintassi

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

Descrizione

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

Nota

A partire da Windows PowerShell 5.0, Write-Host è un wrapper per Questo consente di usare Write-Host per Write-Information generare output nel flusso di informazioni. Ciò consente l'acquisizione o l'eliminazione dei dati scritti usando Write-Host mantenendo la compatibilità con le versioni precedenti.

La variabile di preferenza e InformationAction il $InformationPreference parametro comune non influiscono sui Write-Host messaggi. L'eccezione a questa regola è -InformationAction Ignore, che elimina Write-Host in modo efficace l'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 NoNewline parametro .

Una seconda stringa viene scritta, 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 Separatore viene usato per aggiungere la stringa , +2= (comma, space, +, 2, =, space).

Esempio 3: Scrivere con diversi colori di testo e sfondo

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 ForegroundColor parametro per restituire il testo "verde scuro" e il BackgroundColor parametro per visualizzare uno sfondo "bianco".

Esempio 4: Scrivere con diversi colori di testo e sfondo

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

Red on white text.

Questo comando visualizza la stringa "Rosso sul testo bianco". Il testo è "rosso", come definito dal ForegroundColor parametro. Lo sfondo è "bianco", come definito dal BackgroundColor parametro .

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 "Rosso sul testo bianco". Il testo è "rosso", come definito dal ForegroundColor parametro. Lo sfondo è "bianco", come definito dal BackgroundColor parametro .

Parametri

-BackgroundColor

Specifica il colore di sfondo. Non prevede alcun valore predefinito. I valori validi per questo parametro sono:

  • Nero
  • blu scuro
  • verde scuro
  • verde grigio
  • rosso scuro
  • prugna
  • giallo scuro
  • Grigio
  • grigio scuro
  • Blu
  • Green
  • azzurro
  • Red
  • Fucsia
  • Giallo
  • White
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

Specifica il colore del testo. Non prevede alcun valore predefinito. I valori validi per questo parametro sono:

  • Nero
  • blu scuro
  • verde scuro
  • verde grigio
  • rosso scuro
  • prugna
  • giallo scuro
  • Grigio
  • grigio scuro
  • Blu
  • Green
  • azzurro
  • Red
  • Fucsia
  • Giallo
  • White
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

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.

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

-Object

Oggetti da visualizzare nell'host.

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

-Separator

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

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

Input

Object

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

Output

None

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