Envoie des objets à l'hôte en tant que série de chaînes.
Syntaxe
Out-String [-InputObject <psobject>] [-Stream] [-Width <int>] [<CommonParameters>]
Description
L'applet de commande Out-String convertit les objets gérés par Windows PowerShell en un tableau de chaînes. Par défaut, Out-String accumule les chaînes et les retourne sous forme d'une chaîne unique, mais vous pouvez utiliser le paramètre de flux de données (« stream ») pour demander à Out-String de retourner une chaîne à la fois. Cette applet de commande vous permet de rechercher et manipuler la sortie de chaîne comme dans les interpréteurs de commandes traditionnels quand la manipulation d'objets est moins commode.
Paramètres
-InputObject <psobject>
Spécifie les objets à écrire dans une chaîne. 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 |
-Stream
Envoie séparément les chaînes pour chaque objet. Par défaut, les chaînes pour chaque objet sont accumulées et sont envoyées comme une chaîne unique.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Width <int>
Spécifie le nombre de caractères dans chaque ligne de sortie. Tous les caractères additionnels sont tronqués, et non renvoyés à la ligne. Si vous omettez ce paramètre, la largeur est déterminée par les caractéristiques de l'hôte. La valeur par défaut de l'hôte PowerShell.exe est 80 (caractères).
|
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 les objets vers Out-String. |
|
Sorties |
System.String Out-String retourne la chaîne qu'il crée à partir de l'objet d'entrée. |
Remarques
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 plus d'informations, consultez les exemples.
Exemple 1
C:\PS>get-content C:\test1\testfile2.txt | out-string Description ----------- Cette commande envoie le contenu du fichier Testfile2.txt à la console comme une chaîne unique. Elle utilise l'applet de commande Get-Content pour obtenir le contenu du fichier. L'opérateur de pipeline (|) envoie le contenu à Out-String, qui lui-même l'envoie à la console sous forme de chaîne.
Exemple 2
C:\PS>$c = get-culture | select-object * C:\PS> out-string -inputobject $c -width 100 Description ----------- Ces commandes obtiennent les paramètres régionaux pour l'utilisateur actuel et convertissent les données en chaînes. La première commande utilise l'applet de commande Get-Culture pour obtenir les paramètres régionaux. L'opérateur de pipeline (|) envoie le résultat à l'applet de commande Select-Object, qui sélectionne toutes les propriétés (*) de l'objet de culture que Get-Culture a récupérées. La commande stocke ensuite les résultats dans la variable $c. La deuxième commande utilise Out-String pour convertir l'objet CultureInfo en une série de chaînes (une pour chaque propriété). Elle utilise le paramètre InputObject pour passer la variable $c à Out-String. Le paramètre de largeur (Width) est défini sur 100 caractères par ligne pour empêcher la troncature.
Exemple 3
C:\PS>get-alias | out-string -stream | select-string "Get-Command" Description ----------- Cette commande affiche des alias qui incluent l'expression « Get-Command ». Elle utilise l'applet de commande Get-Alias pour obtenir un jeu d'objets AliasInfo (un pour chaque alias de la session active). Cet exemple illustre la différence entre l'utilisation d'objets et l'utilisation de chaînes. L'opérateur de pipeline (|) envoie la sortie de Get-Alias à Out-String, qui convertit les objets en une série de chaînes. Il utilise le paramètre Stream pour envoyer chaque chaîne individuellement, au lieu de les concaténer en une chaîne unique. Un autre opérateur de pipeline envoie les chaînes à Select-String, qui sélectionne les chaînes qui incluent « Get-Command » n'importe où dans la chaîne. Si vous omettez le paramètre Stream, la commande affiche tous les alias, car Select-String recherche « Get-Command » dans la chaîne unique qu'Out-String retourne, et le formateur affiche la chaîne sous forme de tableau.
Voir aussi