Writes the specified objects to the pipeline.
Syntax Default (Default)Write-Output
[-InputObject] <PSObject[]>
[-NoEnumerate]
[<CommonParameters>]
Description
Writes the specified objects to the pipeline. If Write-Output
is the last command in the pipeline, the objects are displayed in the console.
Write-Output
sends objects to the primary pipeline, also known as the success stream. To send error objects to the error stream, use Write-Error
.
This cmdlet is typically used in scripts to display strings and other objects on the console. One of the built-in aliases for Write-Output
is echo
and similar to other shells that use echo
. The default behavior is to display the output at the end of a pipeline. In PowerShell, it is generally not necessary to use the cmdlet in instances where the output is displayed by default. For example, Get-Process | Write-Output
is equivalent to Get-Process
. Or, echo "Home directory: $HOME"
can be written, "Home directory: $HOME"
.
By default, Write-Output
enumerates objects in a collection. However, Write-Output
can also pass collections down the pipeline as a single object with the NoEnumerate parameter.
In this example, the results of the Get-Process
cmdlet are stored in the $P
variable. The Write-Output
cmdlet displays the process objects in $P
to the console.
$P = Get-Process
Write-Output $P
Example 2: Pass output to another cmdlet
This command pipes the "test output" string to the Get-Member
cmdlet, which displays the members of the System.String class, demonstrating that the string was passed along the pipeline.
Write-Output "test output" | Get-Member
Example 3: Suppress enumeration in output
This command adds the NoEnumerate parameter to treat a collection or array as a single object through the pipeline.
Write-Output 1,2,3 | Measure-Object
Count : 3
...
Write-Output 1,2,3 -NoEnumerate | Measure-Object
Count : 1
...
Parameters -InputObject
Specifies the objects to send down the pipeline. Enter a variable that contains the objects, or type a command or expression that gets the objects.
Parameter properties Type:PSObject[]
Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False -NoEnumerateBy default, the Write-Output
cmdlet always enumerates its output. The NoEnumerate parameter suppresses the default behavior, and prevents Write-Output
from enumerating output. The NoEnumerate parameter has no effect if the command is wrapped in parentheses, because the parentheses force enumeration. For example, (Write-Output 1,2,3 -NoEnumerate)
still enumerates the array.
The NoEnumerate parameter is only useful within a pipeline. Trying to see the effects of NoEnumerate in the console is problematic because PowerShell adds Out-Default
to the end of every command line, which results in enumeration. But if you pipe Write-Output -NoEnumerate
to another cmdlet, the downstream cmdlet receives the collection object, not the enumerated items of the collection.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs PSObjectYou can pipe objects to this cmdlet.
Outputs PSObjectThis cmdlet returns the objects that are submitted as input.
NotesPowerShell includes the following aliases for Write-Output
:
All platforms:
echo
Windows:
write
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4