Partager via

Out-String

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

Envoie des objets à l'hôte sous la forme d'une série de chaînes.

Syntax

Out-String
   [-Stream]
   [-Width <Int32>]
   [-InputObject <PSObject>]
   [<CommonParameters>]

Description

L’applet Out-String de commande convertit les objets que Windows PowerShell gère en tableau de chaînes. Par défaut, Out-String accumule les chaînes et les retourne sous la forme d’une chaîne unique, mais vous pouvez utiliser le paramètre Stream pour diriger Out-String le retour d’une chaîne à la fois. Cette applet de commande vous permet de rechercher et de manipuler la sortie de chaîne comme vous le feriez dans des interpréteurs de commandes traditionnels quand la manipulation des objets est moins pratique.

Exemples

Exemple 1 : texte de sortie dans la console sous forme de chaîne

PS C:\> Get-Content C:\test1\testfile2.txt | Out-String

Cette commande envoie le contenu du fichier Testfile2.txt à la console sous la forme d'une chaîne unique. Il utilise l’applet Get-Content de commande pour obtenir le contenu du fichier. L’opérateur de pipeline (|) envoie le contenu à Out-String, qui envoie le contenu à la console sous forme de chaîne.

Exemple 2 : Obtenir la culture actuelle et convertir les données en chaînes

La première commande utilise l’applet de Get-Culture commande pour obtenir les paramètres régionaux. L’opérateur de pipeline (|) envoie le résultat à l’applet Select-Object de commande, qui sélectionne toutes les propriétés (*) de l’objet de culture retourné Get-Culture . La commande stocke ensuite les résultats dans la $C variable .

La deuxième commande utilise l’applet Out-String de commande pour convertir l’objet CultureInfo en une série de chaînes (une chaîne pour chaque propriété). Il utilise le paramètre InputObject pour passer la $C variable à Out-String. Le paramètre Width est défini sur 100 caractères par ligne pour empêcher la troncation.

PS C:\> $C = Get-Culture | Select-Object *
PS C:\> Out-String -InputObject $C -Width 100

Ces commandes obtiennent les paramètres régionaux de l'utilisateur actuel et convertissent les données en chaînes.

Exemple 3 : Utilisation d’objets

PS C:\> Get-Alias | Out-String -Stream | Select-String "Get-Command"

Cet exemple illustre la différence entre l'utilisation d'objets et l'utilisation de chaînes. La commande affiche les alias qui incluent l'expression « Get-Command ». Il utilise l’applet Get-Alias de commande pour obtenir un ensemble d’objets AliasInfo (un pour chaque alias de la session active).

L’opérateur de pipeline (|) envoie la sortie de l’applet Get-Alias de commande à l’applet Out-String de commande, qui convertit les objets en une série de chaînes. Il utilise le paramètre Stream de Out-String pour envoyer chaque chaîne individuellement, au lieu de les concaténer en une seule chaîne. Un autre opérateur de pipeline envoie les chaînes à l’applet Select-String de commande, 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 qui Out-String retourne et le formateur affiche la chaîne sous forme de tableau.

Paramètres

-InputObject

Spécifie les objets à écrire dans une chaîne. 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

-Stream

Indique que l’applet de commande envoie les chaînes pour chaque objet séparément. Par défaut, les chaînes de chaque objet sont accumulées et envoyées sous la forme d'une chaîne unique.

Pour utiliser le paramètre Stream, tapez -Stream ou son alias, ost.

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

-Width

Spécifie le nombre de caractères dans chaque ligne de la sortie. Tous les caractères supplémentaires sont tronqués, pas renvoyés à la ligne. Le paramètre Width s’applique uniquement aux objets en cours de mise en forme. Si vous omettez ce paramètre, la largeur est déterminée par les caractéristiques du programme hôte. La valeur par défaut pour la console Windows PowerShell est 80 (caractères).

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

Entrées

PSObject

Vous pouvez diriger des objets vers Out-String.

Sorties

String

Out-String retourne la chaîne qu’il crée à partir de l’objet d’entrée.

Notes

  • Les applets de commande qui contiennent le verbe Out qui ne mettez pas en forme d’objets ; ils les restituent 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 l'afficher.
  • Les applets de commande Out n’ont pas de paramètres qui prennent des noms ou des 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 vers l'applet de commande. Vous pouvez également stocker les données dans une variable et utiliser le paramètre InputObject pour passer les données à l'applet de commande.