Write-Host
Écrit une sortie personnalisée dans un hôte.
Syntaxe
Default (Par défaut)
Write-Host
[[-Object] <Object>]
[-NoNewline]
[-Separator <Object>]
[-ForegroundColor <ConsoleColor>]
[-BackgroundColor <ConsoleColor>]
[<CommonParameters>]
Description
L’applet de commande Write-Host personnalise la sortie.
Vous pouvez spécifier la couleur du texte à l’aide du paramètre ForegroundColor, et vous pouvez spécifier la couleur d’arrière-plan à l’aide du paramètre BackgroundColor.
Le paramètre Séparateur 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.
Remarque
À partir de Windows PowerShell 5.0, Write-Host est un wrapper pour Write-Information. Cela vous permet d'utiliser Write-Host pour émettre la sortie vers le flux de données.
Cela permet la capture ou la suppression de données écrites à l’aide de Write-Host tout en préservant la compatibilité descendante.
La variable de préférence $InformationPreference et InformationAction paramètre commun n’affectent pas les messages Write-Host.
L’exception à cette règle est -InformationAction Ignore, ce qui supprime efficacement 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 newline » avec le paramètre NoNewline.
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 Séparateur est utilisé pour ajouter la chaîne , +2= (comma, space, +, 2, =, space).
Exemple 3 : Écrire avec des couleurs de texte et 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 ForegroundColor pour générer du texte « vert foncé » et le paramètre BackgroundColor pour afficher un arrière-plan « blanc ».
Exemple 4 : Écrire avec des couleurs de texte et 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 paramètre ForegroundColor.
L’arrière-plan est « blanc », tel que défini par le paramètre BackgroundColor.
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
Cette commande affiche la chaîne « Rouge sur texte blanc ». Le texte est « rouge », tel que défini par le paramètre ForegroundColor.
L’arrière-plan est « blanc », tel que défini par le paramètre BackgroundColor.
Paramètres
-BackgroundColor
Spécifie la couleur d’arrière-plan. Il n'y a pas de valeur par défaut. Les valeurs acceptables pour ce paramètre sont les suivantes :
- Noir
- Bleu foncé
- Vert foncé
- DarkCyan (en)
- Rouge foncé
- Magenta foncé
- Jaune foncé
- Gris
- Gris foncé
- Bleu
- Vert
- Cyan
- Rouge
- Magenta
- Jaune
- Blanc
Propriétés du paramètre
| Type: | ConsoleColor |
| Valeur par défaut: | None |
| Valeurs acceptées: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ForegroundColor
Spécifie la couleur du texte. Il n'y a pas de valeur par défaut. Les valeurs acceptables pour ce paramètre sont les suivantes :
- Noir
- Bleu foncé
- Vert foncé
- DarkCyan (en)
- Rouge foncé
- Magenta foncé
- Jaune foncé
- Gris
- Gris foncé
- Bleu
- Vert
- Cyan
- Rouge
- Magenta
- Jaune
- Blanc
Propriétés du paramètre
| Type: | ConsoleColor |
| Valeur par défaut: | None |
| Valeurs acceptées: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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 caractères de sortie.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Object
Objets à afficher dans l’hôte.
Propriétés du paramètre
| Type: | Object |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Separator
Spécifie une chaîne de séparation à insérer entre les objets affichés par l’hôte.
Propriétés du paramètre
| Type: | Object |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
Object
Vous pouvez diriger les objets à écrire sur l’hôte.
Sorties
None
Write-Host envoie les objets à l’hôte.
Elle ne retourne aucun objet.
Toutefois, l’hôte peut afficher les objets qui Write-Host l’envoie.