PowerShellを使い始めたばかりの方が最初に触れるコマンドのひとつが「Write-Output」です。
これは、文字列や変数の値を画面に表示したり、次のコマンドレットに値を渡したりするときに使う基本的なコマンドです。
一見すると「Write-Host」との違いが分かりにくかったり、どの場面で使えばいいのか迷ってしまうこともあります。
この記事では、Write-Outputコマンドの基本的な使い方から、他の出力系コマンドとの違い、使う上での注意点までをわかりやすく解説します。
PowerShellをより効率的に使いこなしたい方は、ぜひ最後まで読んでみてください。
Write-Outputは、PowerShellの標準出力ストリームにデータを出力するためのコマンドレットです。
もっと簡単に言えば、「コマンドの結果を次の処理に渡す」役割があります。
Write-Output "こんにちは、PowerShell！"
このように書けば、「こんにちは、PowerShell！」と画面に表示されます。
ただし、これは画面に「表示する」ことが主目的ではありません。Write-Outputは、値を「出力ストリームに送る」ことで、次の処理（パイプライン）にデータを渡す仕組みなのです。
構文はとてもシンプルです。
Write-Output [-InputObject] <Object[]>
このように、出力したい値を渡すだけで機能します。
Write-Output "これはテストメッセージです"
Write-Output "りんご", "バナナ", "みかん"
このようにカンマ区切りで複数の文字列を渡すと、それぞれが改行されて表示されます。
PowerShell初心者が混乱しがちなポイントのひとつに「Write-OutputとWrite-Hostの違い」があります。
Write-Host "これは画面にだけ表示される"
→ 出力ストリームに渡されないため、パイプラインで次に処理を渡すことができません。
Write-Output "これはパイプラインに渡せる"
→ そのまま別のコマンドに値を流せるのが大きな違いです。
Write-Output 1 2 3 4 5 | Where-Object { $_ -gt 3 }
このように、「3より大きい値だけを抽出する」といった使い方が可能です。Write-Hostではこのような処理はできません。
関数の中でWrite-Outputを使うと、その値が関数の戻り値として扱われてしまうことがあります。
これを避けたい場合は、明示的にreturnやOut-Nullを使って制御することが大切です。
function Test-Output {
Write-Output "これは戻り値になります"
}
この関数を呼び出すと、出力として値が返されます。
パイプラインを活用する場面ではWrite-Outputは非常に便利です。
しかし、単に表示したいだけで使うと、思わぬトラブル（他のコマンドに値が渡ってしまうなど）が発生することもあります。
「表示したい」だけならWrite-Hostを、「処理に値を渡したい」ならWrite-Outputを、というように目的を明確にすることが重要です。
$mode = "debug"
if ($mode -eq "debug") {
Write-Output "デバッグモードです"
} else {
Write-Output "通常モードです"
}
このように、条件によって異なるメッセージや処理を渡すことができます。
$data = Write-Output "ログ出力のテスト"
$data | Out-File -FilePath "./log.txt"
出力されたデータをファイルに保存する処理の一部として使うことも可能です。
PowerShellでは、Write-Outputは省略可能です。
つまり、以下のように直接値を書くことで、同じ結果が得られます。
"こんにちは"
これは暗黙的にWrite-Outputが実行されているためです。
ただし、スクリプトの可読性や明確さを考えると、特に初心者のうちは明示的にWrite-Outputを使った方が無難です。
Write-Outputはただ画面に表示するだけのコマンドではなく、次の処理に値を「渡す」ための仕組みです。
表示用のWrite-Hostとは異なる目的で使うことを意識すると、PowerShellの理解が一段と深まります。
特にスクリプト内でデータを流しながら処理を組み立てていく際には、Write-Outputはなくてはならない存在です。
処理の途中経過を表示しながら値も渡したい、そんなときにこそ力を発揮します。
PowerShellのスクリプトを書く上で、ぜひ活用してみてください。