HOWTO · PowerShell
PowerShell で echo 相当の機能
このチュートリアルでは、PowerShell でスクリプトと関数の echo に相当するコマンドを紹介します。
このページの内容
PowerShell では、echo は Write-Output のエイリアスです。これを使うか、Write-Output を直接呼び出すと、値を成功出力ストリームに送れます。その値が別のコマンドにパイプされない場合は、対話型シェルに表示されます。コンソールを見る人だけに向けたメッセージには Write-Host を、任意の診断メッセージには Write-Debug または Write-Verbose を使います。
次の例を実行します。コード例と表示される文字列は、元の例とのバイト単位の一致を保つため英語のままです。
Write-Output "Hello World!"
PowerShell で echo の代わりに使えるコマンドは?
echo は Write-Output の便利なエイリアスです。そのため、echo "Hello World!" を使う既存のスクリプトも、同じ出力ストリームに文字列を送ります。再利用するスクリプトでは、Write-Output と明記すると、動作が分かりやすくなります。値を画面に表示したり、別のコマンドに渡したりする場合、これが PowerShell で最も近い代替手段です。
パイプラインに出力を送るには Write-Output を使う
Write-Output は、オブジェクトを PowerShell の成功出力ストリームに書き込みます。後続のコマンドがそのオブジェクトを受け取らない場合はシェルに表示されますが、パイプラインを通じて別の処理に渡すこともできます。たとえば、Write-Output "Hello World!" | Set-Content -Path message.txt とすると、文字列は最終結果として表示されるのではなく、次のコマンドに送られます。通常は値を引数として渡せばよく、-InputObject パラメーターを名前付きで指定する必要はありません。
関数から呼び出し元へデータを返すときや、後続のパイプライン処理で値を絞り込み、変換、保存するときに、このコマンドレットを使います。呼び出し元が取得する必要のあるデータには、ホストへの表示だけを使わないでください。
コンソールに直接表示するには Write-Host を使う
Write-Host "Hello World!" を使うと、現在の PowerShell ホストにメッセージを直接表示できます。短い進捗表示や色付きの状態メッセージなど、ユーザーに見せるための表示に使います。この文字列は成功出力ストリームには送られないため、呼び出し元が通常のパイプラインデータとして処理することはできません。
Write-Host では、-Object パラメーターを名前付きで指定する必要はありません。スクリプトや関数から返す値には Write-Output を使い、メッセージを表示すること自体が目的の場合に Write-Host を使います。
診断メッセージには Write-Debug と Write-Verbose を使う
診断メッセージは、通常の成功出力とは別のものです。Write-Debug "Checking configuration" はデバッグ情報を示し、Write-Verbose "Loading configuration" は追加の運用情報を示します。それぞれの表示は、$DebugPreference と $VerbosePreference によって個別に制御されます。
$DebugPreference の既定値は SilentlyContinue なので、通常はデバッグメッセージが表示されません。$DebugPreference = "Continue" に設定すると、スクリプトの実行を続けながらメッセージを表示できます。同様に、$VerbosePreference = "Continue" に設定すると、Write-Verbose のメッセージが表示されます。高度な関数やスクリプトでは、呼び出し元が共通パラメーターの -Verbose を使って詳細メッセージを有効にできるのが一般的です。通常の出力にデバッグや詳細メッセージのラベルを付けるのではなく、目的に合った診断メッセージを使い分けてください。
文字列リテラルを直接出力する
PowerShell の式として引用符で囲んだ文字列を使うと、成功出力ストリームに値が出力されます。対話型シェルですぐに確認するには、プロンプトで "Hello World!" と入力します。この簡潔な方法は値を試すときに便利ですが、長いスクリプトでは Write-Output を明示的に呼び出すと意図が伝わりやすくなります。ほかの成功出力ストリームの値と同様に、文字列はすぐに表示する代わりに取得したり、後続のコマンドへパイプしたりできます。
用途に合った出力方法を選ぶ
メッセージを受け取る相手に応じて選びます。
- 呼び出し元、パイプライン、またはシェル表示に渡すデータを生成するには、
Write-Output(またはそのechoエイリアス)を使います。 - ホストに表示し、パイプラインデータとして返す必要のない内容には、
Write-Hostを使います。 - デバッグ診断には
Write-Debugを、任意の運用情報にはWrite-Verboseを使います。それぞれに対応する設定値、またはサポートされている共通パラメーターで有効にします。 - 対話型シェルで式を手早く評価するには、引用符で囲んだ文字列だけを入力します。
これらの方法は相互に置き換えられるものではありません。関数の呼び出し元が値を取得、変換、またはリダイレクトする必要がある場合は、成功出力ストリームに送ります。ホストへの直接表示や診断ストリームは、関数の戻り値としてデータを渡すのではなく、人に知らせることが目的のメッセージに使います。