Out-Host

Article
01/13/2010

Envoie la sortie à la ligne de commande.

Syntaxe

Out-Host [-InputObject <psobject>] [-Paging] [<CommonParameters>]

Description

L'applet de commande Out-Host envoie la sortie à l'hôte Windows PowerShell pour affichage. L'hôte affiche la sortie à la ligne de commande. Dans la mesure où Out-Host est la valeur par défaut, vous n'avez pas besoin de la spécifier, sauf si vous souhaitez utiliser ses paramètres pour modifier l'affichage.

Paramètres

-InputObject <psobject>

Spécifie les objets qui sont écrits dans la console. Entrez une variable contenant les objets, ou tapez une commande ou une expression permettant d'obtenir ces objets.

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

-Paging

Affiche une page de sortie à la fois, et attend l'entrée utilisateur avant d'afficher les pages restantes, à l'image de la commande classique « more ». Par défaut, toute la sortie est affichée dans une page seule. La taille de page est déterminée par les caractéristiques de l'hôte.

Obligatoire ?	false
Position ?	named
Valeur par défaut
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.Management.Automation.PSObject

Vous pouvez diriger n'importe quel objet vers Out-Host.

Sorties

Aucun

Out-Host ne génère aucune sortie. Toutefois, l'hôte peut afficher les objets qu'Out-Host lui envoie.

Remarques

Vous pouvez également faire référence à Out-Host par son alias intégré, « oh ». Pour plus d'informations, consultez about_Aliases.

Les applets de commande contenant le verbe Out (les applets de commande Out) ne mettent pas en forme les objets ; elles les restituent seulement et les envoient à la destination d'affichage spécifiée. Si vous envoyez un objet non mis en forme à une applet de commande Out, l'applet de commande l'envoie à une applet de commande de mise en forme avant de le restituer.

Les applets de commande Out n'ont pas de paramètres pour les noms ou les chemins d'accès aux fichiers. Pour envoyer des données à une applet de commande Out, utilisez un opérateur de pipeline (|) pour envoyer la sortie d'une commande Windows PowerShell à l'applet de commande. Vous pouvez également stocker des données dans une variable et utiliser le paramètre InputObject pour passer les données à l'applet de commande. Pour l'aide, consultez les exemples.

Out-Host envoie des données, mais n'émet pas d'objets de sortie. Si vous dirigez la sortie d'Out-Host vers Get-Member, Get-Member indique qu'aucun objet n'a été spécifié.

Exemple 1

C:\PS>get-process | out-host -paging

Description
-----------
Cette commande affiche les processus sur le système une page à la fois. Elle utilise la commande Get-Process pour obtenir les processus sur le système. L'opérateur de pipeline (|) envoie les résultats à Out-Host, qui les affiche sur la console. Le paramètre Paging affiche une page de données à la fois.

Le même format de commande est utilisé pour la fonction Help qui est intégrée à Windows PowerShell. Cette fonction obtient des données de Get-Help, puis utilise le paramètre Paging d'Out-Host pour afficher les données une page à la fois à l'aide de du format de commande suivant : get-help $args[0] | out-host -paging).

Exemple 2

C:\PS>$a = get-history

C:\PS>out-host -InputObject $a

Description
-----------
Ces commandes affichent l'historique de la session à la ligne de commande. La première commande utilise l'applet de commande Get-History pour obtenir l'historique de la session, puis stocke cet historique dans la variable $a. La deuxième commande utilise Out-Host pour afficher le contenu de la variable $a, et utilise le paramètre InputObject pour spécifier la variable à Out-Host.

Voir aussi

Concepts

Out-Printer
Out-Null
Out-File
Out-String
Out-Default
Write-Host

Partager via