Out-String
Envoie des objets à l’hôte sous la forme d’une série de chaînes.
Syntaxe
Default (Par défaut)
Out-String
[-Stream]
[-Width <Int32>]
[-InputObject <PSObject>]
[<CommonParameters>]
Description
L’applet de commande Out-String 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 forme de chaîne unique, mais vous pouvez utiliser le paramètre Stream pour diriger Out-String pour retourner 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 les interpréteurs de commandes traditionnels lorsque la manipulation d’objets est moins pratique.
Exemples
Exemple 1 : Sortie de texte 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 forme de chaîne unique.
Il utilise l’applet de commande Get-Content 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 de caractères
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 qui Get-Culture retourné.
La commande stocke ensuite les résultats dans la variable $C.
La deuxième commande utilise l’applet de commande Out-String 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
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 : Travailler avec des 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 des alias qui incluent l’expression « Get-Command ».
Il utilise l’applet de commande
L’opérateur de pipeline (|) envoie la sortie de l’applet de commande Get-Alias à l’applet de commande Out-String, 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 de commande 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 trouve « Get-Command » dans la chaîne unique retournée par Out-String, 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 qui contient les objets, ou tapez une commande ou une expression qui obtient les objets.
Propriétés du paramètre
| Type: | PSObject |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Stream
Indique que l’applet de commande envoie les chaînes de chaque objet séparément. Par défaut, les chaînes de chaque objet sont accumulées et envoyées sous forme de chaîne unique.
Pour utiliser le paramètre Stream
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Width
Spécifie le nombre de caractères dans chaque ligne de sortie. Tous les caractères supplémentaires sont tronqués, et non encapsulés. Le paramètre Width s’applique uniquement aux objets mis 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 de la console Windows PowerShell est de 80 caractères.
Propriétés du paramètre
| Type: | Int32 |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
PSObject
Vous pouvez diriger des objets vers Out-String.
Sorties
String
Out-String retourne la chaîne qu’elle crée à partir de l’objet d’entrée.
Notes
- Applets de commande qui contiennent le verbe Out qui ne mettez pas en forme les objets ; ils les affichent 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 la rendre.
- 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 à 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.