écrit une sortie personnalisée sur un hôte.
syntaxe
Description
l’objectif principal de l’applet de commandeWrite-Host est de produire une sortie uniquement pour l’affichage(hôte), telle que l’impression de texte coloré, comme lors de l’invite de l’utilisateur à entrer en conjonction avecWrite-Host utilise la méthode ToString() pour écrire theoutput., En revanche, pour sortir des données vers le pipeline, utilisez Write-Output ou implicitoutput.
Vous pouvez spécifier la couleur du texte en utilisant le paramètreForegroundColor, et vous pouvez spécifier la couleur du fond en utilisant le paramètreBackgroundColor. 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 esthosting PowerShell.
Remarque
à partir de Windows PowerShell 5.,0, Write-Host est un wrapper pour le Write-Information Cette allowsyou pour utiliser Write-Host pour émettre de la sortie du flux d’informations. Cela permet la capture ou la sauvegarde de données écrites à l’aide de Write-Host tout en préservant la rétrocompatibilité.
la variable de préférence$InformationPreferenceet le paramètre communInformationActionne correspondent pas aux messagesWrite-Host. L’exception à cette règle est -InformationAction Ignore, ce qui supprime efficacement la sortie Write-Host., (voir « Exemple 5 »)
exemples
exemple 1: écrire dans la console sans ajouter de nouvelle ligne
Cette commande affiche la chaîne » pas de test de nouvelle ligne »avec le paramètreNoNewline.
Une deuxième chaîne est écrite, mais elle se retrouve sur la même ligne que la première en raison de l’absence de nouvelle ligne séparant les chaînes.,
exemple 2: écrire dans la console et inclure un séparateur
exemple 3: écrire avec du texte et des couleurs d’arrière-plan différentes
Cette commande affiche les nombres pairs de deux à douze. Il utilise le paramètreForegroundColorpour afficher du texte vert foncé et le paramètreBackgroundColor pour afficher un fond blanc.
exemple 4: écrire avec du texte et des couleurs d’arrière-plan différentes
Cette commande affiche la chaîne « rouge sur le texte blanc., »Le texte est Rouge, tel que défini par le paramètreForegroundColor. L’arrière-plan est blanc, tel que défini par le paramètre BackgroundColor.
exemple 5: supprimer la sortie de L’hôte D’écriture
Ces commandes suppriment efficacement la sortie de l’applet de commandeWrite-Host. Le premier utilise le paramètreInformationAction avec la valeur Ignore pour supprimer la sortie vers le flux d’informations.,Le deuxième exemple redirige le flux d’informations de la commande vers la variable $null et la supprime.
Paramètres
Spécifie la couleur d’arrière-plan. Il n’y a pas de valeur par défaut.,ellow
| 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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the text color., Il n’y a pas de valeur par défaut.,
The string representations of the input objects are concatenated to form the output., Aucun espace ou 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 |
| Poste: | Nom |
| valeur par Défaut: | Aucun |
| Accepter pipeline d’entrée: | False |
| Accepter les caractères génériques: | False |
affichage des Objets dans l’hôte.,
| Type: | Object |
| Aliases: | Msg, Message |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies a separator string to insert between objects displayed by the host.,
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Object
You can pipe objects to be written to the host.
Outputs
None
Write-Host sends the objects to the host. It does not return any objects., Cependant, hostdisplays les objets queWrite-Host lui envoie.
Notes
-
lors de l’écriture d’une collection sur l’hôte, les éléments de la collection sont imprimés sur les mêmes lignes séparées par un seul espace. Cela 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 une sortie significative. Par exemple,
Write-Host @{a = 1; b = 2}afficheraSystem.Collections.DictionaryEntry System.Collections.DictionaryEntrysur l’hôte.,
- Clear-Host
- Out-Host
- Write-Debug
- Write-Error
- Write-Output
- Inscrivez-Cours
- Write-Verbose
- Écriture d’Alerte