Write-Host
Écrit la sortie personnalisée sur un hôte.
Syntax
Write-Host
[[-Object] <Object>]
[-NoNewline]
[-Separator <Object>]
[-ForegroundColor <ConsoleColor>]
[-BackgroundColor <ConsoleColor>]
[<CommonParameters>]
Description
L’objectif Write-Host
principal de l’applet de commande est de produire une sortie for-(host)-display-only, telle que l’impression de texte couleur, comme lorsque l’utilisateur invite l’utilisateur à entrer une entrée conjointement avec Read-Host.
Write-Host
utilise la méthode ToString() pour écrire la sortie. En revanche, pour générer des données dans le pipeline, utilisez Write-Output ou une sortie implicite.
Vous pouvez spécifier la couleur du texte à l’aide du ForegroundColor
paramètre , et vous pouvez spécifier la couleur d’arrière-plan à l’aide du BackgroundColor
paramètre . Le paramètre Separator vous permet de spécifier une chaîne à utiliser pour séparer les objets affichés. Le résultat particulier dépend du programme qui héberge PowerShell.
Notes
À partir de Windows PowerShell 5.0, Write-Host
est un wrapper pour cela vous permet d’utiliser Write-Host
pour Write-Information
émettre une sortie vers le flux d’informations. Cela permet la capture ou la suppression des données écrites à l’aide Write-Host
de tout en préservant la compatibilité descendante.
La $InformationPreference
variable de préférence et InformationAction
le paramètre commun n’affectent pas les Write-Host
messages. L’exception à cette règle est -InformationAction Ignore
, qui supprime efficacement la Write-Host
sortie. (voir « Exemple 5 »)
Exemples
Exemple 1 : Écrire dans la console sans ajouter de nouvelle ligne
Write-Host "no newline test " -NoNewline
Write-Host "second string"
no newline test second string
Cette commande affiche la chaîne « aucun test de nouvelle ligne » avec le NoNewline
paramètre .
Une deuxième chaîne est écrite, mais elle se termine sur la même ligne que la première en raison de l’absence d’une nouvelle ligne séparant les chaînes.
Exemple 2 : écrire dans la console et inclure un séparateur
Write-Host (2,4,6,8,10,12) -Separator ", +2= "
2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12
Cette commande affiche les nombres pairs de deux à douze. Le paramètre Separator est utilisé pour ajouter la chaîne , +2=
(virgule, espace, +
, 2
, =
espace).
Exemple 3 : Écrire avec du texte et des couleurs d’arrière-plan différentes
Write-Host (2,4,6,8,10,12) -Separator ", -> " -ForegroundColor DarkGreen -BackgroundColor White
2, -> 4, -> 6, -> 8, -> 10, -> 12
Cette commande affiche les nombres pairs de deux à douze. Il utilise le paramètre pour générer du ForegroundColor
texte vert foncé et le BackgroundColor
paramètre pour afficher un arrière-plan blanc.
Exemple 4 : Écrire avec du texte et des couleurs d’arrière-plan différentes
Write-Host "Red on white text." -ForegroundColor red -BackgroundColor white
Red on white text.
Cette commande affiche la chaîne « Rouge sur texte blanc ». Le texte est rouge, tel que défini par le ForegroundColor
paramètre . L’arrière-plan est blanc, tel que défini par le BackgroundColor
paramètre .
Exemple 5 : Supprimer la sortie 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
Ces commandes suppriment efficacement la sortie de l’applet Write-Host
de commande. Le premier utilise le InformationAction
paramètre avec la Ignore
valeur pour supprimer la sortie du flux d’informations.
Le deuxième exemple redirige le flux d’informations de la commande vers la $null
variable et le supprime ainsi.
Paramètres
-BackgroundColor
Spécifie la couleur d'arrière-plan. Il n'y a pas de valeur par défaut. Les valeurs valides pour ce paramètre sont :
- Noir
- DarkBlue
- DarkGreen
- DarkCyan
- DarkRed
- DarkMagenta
- DarkYellow
- Gris
- DarkGray
- Blue
- Vert
- Cyan
- Rouge
- Magenta
- Jaune
- 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
Spécifie la couleur du texte. Il n'y a pas de valeur par défaut. Les valeurs valides pour ce paramètre sont :
- Noir
- DarkBlue
- DarkGreen
- DarkCyan
- DarkRed
- DarkMagenta
- DarkYellow
- Gris
- DarkGray
- Blue
- Vert
- Cyan
- Rouge
- Magenta
- Jaune
- 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
Les représentations sous forme de chaîne des objets d’entrée sont concaténées pour former la sortie. Aucun espace ou nouvelle ligne n’est inséré entre les chaînes de sortie. Aucune nouvelle ligne n’est ajoutée après la dernière chaîne de sortie.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Object
Objets à afficher dans l’hôte.
Type: | Object |
Aliases: | Msg, Message |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Separator
Spécifie une chaîne de séparation à insérer entre les objets affichés par l’hôte.
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
Vous pouvez diriger les objets à écrire vers l'hôte.
Sorties
None
Write-Host
envoie les objets à l’hôte. Aucun objet n'est retourné. Toutefois, l’hôte affiche les objets qui Write-Host
lui sont envoyés.
Notes
Lors de l’écriture d’une collection sur l’hôte, les éléments de la collection sont imprimés sur la même ligne séparée par un espace unique. Ce paramètre peut être remplacé par le paramètre Separator .
Les types de données non primitifs tels que les objets avec des propriétés peuvent provoquer des résultats inattendus et ne pas fournir de sortie significative. Par exemple,
Write-Host @{a = 1; b = 2}
s’imprimeSystem.Collections.DictionaryEntry System.Collections.DictionaryEntry
sur l’hôte.