Write-Host

Article
01/13/2010

Écrit la sortie personnalisée sur un hôte.

Syntaxe

Write-Host [[-Object] <Object>] [-BackgroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-ForegroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-NoNewline] [-Separator <Object>] [<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, ainsi que la couleur d'arrière-plan à l'aide du paramètre BackgroundColor. Le paramètre Separator vous permet de spécifier une chaîne à utiliser pour séparer les objets affichés. Le résultat spécifique dépend du programme qui héberge Windows PowerShell.

Paramètres

-BackgroundColor <ConsoleColor>

Spécifie la couleur d'arrière-plan. Il n'y a pas de valeur par défaut.

Obligatoire ?	false
Position ?	named
Valeur par défaut	aucun
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-ForegroundColor <ConsoleColor>

Spécifie la couleur du texte. Il n'y a pas de valeur par défaut.

Obligatoire ?	false
Position ?	named
Valeur par défaut	aucun
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-NoNewline

Spécifie que le contenu affiché sur la console ne se termine pas avec un caractère de nouvelle ligne.

Obligatoire ?	false
Position ?	named
Valeur par défaut	aucun
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Object <Object>

Objets à afficher sur la console.

Obligatoire ?	false
Position ?	1
Valeur par défaut	aucun
Accepter l'entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-Separator <Object>

Chaîne de la sortie entre les objets affichés sur la console.

Obligatoire ?	false
Position ?	named
Valeur par défaut	aucun
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.

Entrées et sorties

Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.

Entrées

System.Object

Vous pouvez diriger des objets à écrire dans l'hôte.

Sorties

Aucun

Write-Host envoie les objets à l'hôte. Elle ne retourne aucun objet. Toutefois, l'hôte peut afficher les objets que Write-Host lui envoie.

Exemple 1

C:\PS>write-host "no newline test " -nonewline

no newline test C:\PS>

Description
-----------
Cette commande affiche l'entrée sur la console mais, en raison du paramètre NoNewline, la sortie est directement suivie par l'invite.

Exemple 2

C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= "

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

Description
-----------
Cette commande affiche les nombres pairs, de 2 à 12. Le paramètre Separator est utilisé pour ajouter la chaîne, +2 = (virgule, espace, +, 2, =, espace).

Exemple 3

C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white

Description
-----------
Cette commande affiche les nombres pairs, de 2 à 12. Elle utilise le paramètre ForegroundColor pour produire un texte vert foncé et le paramètre BackgroundColor pour afficher un arrière-plan blanc.

Exemple 4

C:\PS>write-host "Red on white text." -ForegroundColor red -BackgroundColor white

Red on white text.

Description
-----------
Cette commande affiche la chaîne « Texte rouge sur blanc ». Le texte est rouge, tel que défini par le paramètre ForegroundColor. L'arrière-plan est blanc, ainsi que défini par le paramètre BackgroundColor.

Voir aussi

Concepts

Write-Verbose
Write-Error
Write-Progress
Write-Debug
Write-Output
Write-Warning
Out-Host

Partager via