Out-String
SYNOPSIS
Sends objects to the host as a series of strings.
SYNTAX
Out-String [-inputObject <psobject>] [-width <int>] [-stream] [<CommonParameters>]
DETAILED DESCRIPTION
The Out-String cmdlet converts the objects that Windows PowerShell manages into an array of strings. By default, Out-String accumulates the strings and returns them as a single string, but you can use the stream parameter to direct Out-String to return one string at a time. This cmdlet lets you search and manipulate string output as you would in traditional shells when object manipulation is less convenient.
PARAMETERS
-inputObject <psobject>
Specifies the objects to be written to a string. Enter a variable that contains the objects or type a command or expression that gets the objects.
|
Required? |
false |
|
Position? |
named |
|
Default value |
|
|
Accept pipeline input? |
true (ByValue) |
|
Accept wildcard characters? |
false |
-width <int>
Specifies the number of characters in each line of output. Any additional characters are truncated, not wrapped. If you omit this parameter, the width is determined by the characteristics of the host. The default for the PowerShell.exe host is 80 (characters).
|
Required? |
false |
|
Position? |
named |
|
Default value |
80 |
|
Accept pipeline input? |
false |
|
Accept wildcard characters? |
false |
-stream <SwitchParameter>
Sends the strings for each object separately. By default, the strings for each object are accumulated and sent as a single string.
|
Required? |
false |
|
Position? |
named |
|
Default value |
False |
|
Accept pipeline input? |
false |
|
Accept wildcard characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".
INPUT TYPE
Any
RETURN TYPE
String
NOTES
For more information, type "Get-Help Out-String -detailed". For technical information, type "Get-Help Out-String -full".
When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".
The Out cmdlets do not format objects; they just render them and send them to the specified display destination. If you send an unformatted object to an Out cmdlet, the cmdlet sends it to a formatting cmdlet before rendering it.
The Out cmdlets do not have parameters for names or file paths. To send data to an Out cmdlets, use a pipeline operator (|) to send the output of a Windows PowerShell command to the cmdlet. You can also store data in a variable and use the InputObject parameter to pass the data to the cmdlet. For help, see the examples.
EXAMPLE 1
get-content C:\test1\testfile2.txt | out-string
This command sends the content of the Testfile2.txt file to the console as a single string. It uses the Get-Contentcmdlet to get the content of file. The pipeline operator (|) sends the content to Out-String, which sends the content to the console as a string.
EXAMPLE 2
$c = get-culture | select-object *
out-string -inputobject $c -width 100
These commands get the regional settings for the current user and convert the data to strings. The first command uses the Get-Culturecmdlet to get the regional settings. The pipeline operator (|) sends the result to the Select-Objectcmdlet, which selects all properties (*) of the culture object that Get-Culture retrieved. The command then stores the results in the $c variable.
The second command uses Out-String to convert the CultureInfo object to a series of strings; one for each property. It uses the InputObject parameter to pass the $c variable to Out-String. The width parameter is set to 100 characters per line to prevent truncation.
EXAMPLE 3
get-alias | out-string -stream | select-string "Get-Command"
This command displays aliases that includes the phrase " Get-Command". It uses the Get-Aliascmdlet to get a set of AliasInfo objects; one for each alias in the shell. This examples demonstrates the difference between working with objects and working with strings.
The pipeline operator (|) sends the output of Get-Alias to Out-String, which converts the objects to a series of strings. It uses the -stream parameter to send each string individually, instead of concatenating them into a single string. Another pipeline operator sends the strings to Select-String, which selects the strings that include "Get-Command" anywhere in the string.
If you omit the -stream parameter, the command displays all of the aliases, because Select-String finds "Get-Command" in the single string that Out-String returns, and the formatter displays the string as a table.
RELATED LINKS