PowerShell Redirection: Why Write-Host to File Isn't Working?

In this article, we will explore the behavior of redirection in PowerShell, specifically when using the Write-Host cmdlet. We will discuss why it might not work as expected and provide alternative solutions for writing output to a file.

Understanding Redirection in PowerShell

PowerShell supports several types of redirection: output, error, verbose, debug, and information. These redirections can be achieved using the following operators:

• >: Redirects output to a file
• >>: Appends output to a file
• >$var: Redirects output to a variable
• 2>: Redirects error output to a file
• 2>>: Appends error output to a file
• 2>$var: Redirects error output to a variable

The Write-Host cmdlet

The Write-Host cmdlet writes output directly to the console, bypassing the regular success output stream. As a result, redirecting its output using the standard redirection operators (>, >>) does not yield the expected results.

Why Write-Host Output Does Not Get Redirected to a File?

The reason Write-Host output does not get redirected to a file is due to its design. Write-Host targets the host program (in this case, the PowerShell console or PowerShell ISE) and not the success output stream. Redirection operators only affect the success output stream.

Alternatives for Writing Output to a File

Although Write-Host does not support redirection, you can still write output to a file using other cmdlets such as Out-File, Set-Content, Add-Content, or > by utilizing PowerShell variables.

Using Out-File, Set-Content, and Add-Content

Instead of using Write-Host, you can use the following cmdlets to write output to a file:

• Out-File: Creates a new file and writes the output to it. If the file already exists, it gets overwritten.
• Set-Content: Creates a new file and writes the output to it. If the file already exists, it gets overwritten. It is the preferred cmdlet when writing string data to a file.
• Add-Content: Appends the output to an existing file or creates a new file if it does not exist.

Using Variables

You can use PowerShell variables to capture output from the Write-Host cmdlet and then write the variable content to a file using another cmdlet like Out-File, Set-Content, or Add-Content.

Example: Using Out-File, Set-Content, and Add-Content

# Example using Out-File
Write-Output "Hello, World!" | Out-File C:\temp\output.txt

# Example using Set-Content
$output = "Hello, World!"
Set-Content C:\temp\output.txt $output

# Example using Add-Content
$output = "Hello, World!"
Add-Content C:\temp\output.txt $output

Example: Using Variables

# Example using variables
$hostOutput = Write-Host "Hello, World!"
$hostOutput | Out-File C:\temp\output.txt

In this article, we covered the PowerShell redirection topic, focusing on the behavior of the Write-Host cmdlet and why its output cannot be redirected to a file using standard redirection operators. We provided alternative solutions, such as using the Out-File, Set-Content, and Add-Content cmdlets, and demonstrated how to utilize variables in combination with Write-Host.

References

• About Redirection (Microsoft)
• PowerShell Redirections (Tutorials Point)
• PowerShell Redirection Operators (SS64.com)