Out-Host

  • Référence
Module:
Microsoft.PowerShell.Core

Envoie la sortie vers la ligne de commande.

Syntax

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

Description

L’applet Out-Host de commande envoie la sortie à l’hôte PowerShell pour l’affichage. L'hôte affiche la sortie sur la ligne de commande. Comme il s’agit Out-Host de la valeur par défaut, vous n’avez pas besoin de la spécifier, sauf si vous souhaitez utiliser ses paramètres.

Out-Host est automatiquement ajouté à chaque commande exécutée. Il transmet la sortie du pipeline à l’hôte exécutant la commande. Out-Host ignore les séquences d’échappement ANSI. Les séquences d’échappement sont gérées par l’hôte. Out-Host transmet des séquences d’échappement ANSI à l’hôte sans essayer de les interpréter ou de les modifier.

Exemples

Exemple 1 : Afficher la sortie d’une page à la fois

Cet exemple montre comment afficher les processus système d’une page à la fois.

Get-Process | Out-Host -Paging

NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     30    24.12      36.95      15.86   21004  14 ApplicationFrameHost
     55    24.33      60.48      10.80   12904  14 BCompare
<SPACE> next page; <CR> next line; Q quit
      9     4.71       8.94       0.00   16864  14 explorer
<SPACE> next page; <CR> next line; Q quit

Get-Process obtient les processus système et envoie les objets vers le bas du pipeline. Out-Host utilise le paramètre de pagination pour afficher une page de données à la fois.

Exemple 2 : Utiliser une variable comme entrée

Cet exemple utilise des objets stockés dans une variable comme entrée pour Out-Host.

$io = Get-History
Out-Host -InputObject $io

Get-History obtient l’historique de la session PowerShell et stocke les objets dans la $io variable. Out-Host utilise le paramètre InputObject pour spécifier la $io variable et affiche l’historique.

Paramètres

-InputObject

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

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Paging

Indique qu’une Out-Host page de sortie s’affiche à la fois et attend l’entrée de l’utilisateur avant que les pages restantes ne soient affichées. Par défaut, toutes les sorties sont affichées sur une seule page. La taille de la page est déterminée par les caractéristiques de l'hôte.

Appuyez sur la barre d’espace pour afficher la page suivante de la sortie ou la touche Entrée pour afficher la ligne de sortie suivante. Appuyez sur Q pour quitter.

La pagination est similaire à la commande la plus grande.

Notes

Le paramètre de pagination n’est pas pris en charge par l’hôte PowerShell ISE.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSObject

Vous pouvez envoyer des objets vers le pipeline vers Out-Host.

Sorties

None

Out-Host ne génère aucune sortie. Il envoie des objets à l’hôte à des fins d’affichage.

Notes

Le paramètre de pagination n’est pas pris en charge par tous les hôtes PowerShell. Par exemple, si vous utilisez le paramètre pagination dans PowerShell ISE, l’erreur suivante s’affiche : out-lineoutput : The method or operation is not implemented.

Les applets de commande qui contiennent le verbe Out , Out-ne mettez pas en forme les objets. Ils restituent les objets et les envoient à la destination d’affichage spécifiée. Si vous envoyez un objet non mis en forme à une Out- applet de commande, l’applet de commande l’envoie à une applet de commande de mise en forme avant de la rendre.

Les Out- applets de commande n’ont pas de paramètres pour les noms ou les chemins d’accès aux fichiers. Pour envoyer des données à une Out- applet de commande, utilisez le pipeline pour envoyer la sortie d’une commande PowerShell à l’applet de commande. Vous pouvez également stocker des données dans une variable et utiliser le paramètre InputObject pour transmettre les données à l’applet de commande.

Out-Host envoie des données, mais elles ne produisent aucun objet de sortie. Si vous pipelinez la sortie vers l’applet Get-Member de Out-Host commande, Get-Member signale qu’aucun objet n’a été spécifié.