指定されたオブジェクトをパイプラインの次のコマンドに送信します。コマンドがパイプラインの最後のコマンドである場合、オブジェクトはコンソールに表示されます。
構文
説明
Write-Output
コマンドレットは、指定されたオブジェクトをパイプラインから次のコマンドに送信します。コマンドがパイプラインの最後のコマンドである場合、オブジェクトはがコンソールに表示されます。
Write-Output
は、「出力ストリーム」または「成功パイプライン」とも呼ばれるプライマリパイプラインにオブジェクトを送信します。エラーオブジェクトをエラーパイプラインに送信するには、Write-Errorを使用します。
このコマンドレットは通常、スクリプトで使用され、文字列やその他のオブジェクトをコンソールに表示します。 Write-Output
の組み込みエイリアスの1つはecho
であり、echo
、デフォルトの動作は、パイプラインの最後に出力を表示することです。 PowerShellでは、通常、出力がデフォルトで表示されるインスタンスでコマンドレットを使用する必要はありません。たとえば、Get-Process | Write-Output
はGet-Process
と同等です。または、echo "Home directory: $HOME"
と書くことができます。"Home directory: $HOME"
。
デフォルトでは、Write-Output
は、コマンドレットに提供されたコレクションを介して列挙します。ただし、Write-Output
を使用して、NoEnumerateパラメーターを使用してコレクションを単一のオブジェクトとしてパイプラインに渡すこともできます。
例
例1:オブジェクトを取得してコンソールに書き込みます
最初のコマンドは、コンピューターで実行されているプロセスを取得し、それらを$P
変数。
2番目と3番目のコマンドは、コンソールの$P
にプロセスオブジェクトを表示します。
例2:出力を渡す別のコマンドレットに
このコマンドは、「テスト出力」文字列をGet-Member
コマンドレットにパイプします。 System.Stringクラスのメンバーであり、文字列がパイプラインに沿って渡されたことを示しています。
例3:出力の列挙を抑制する
このコマンドは、NoEnumerateパラメーターを追加して、パイプラインを介してコレクションまたは配列を単一のオブジェクトとして扱います。
パラメーター
パイプラインに送信するオブジェクトを指定します。オブジェクトを含む変数、またはオブジェクトを取得するtypeaコマンドまたは式を入力します。
タイプ: | PSObject |
位置: | 0 |
デフォルト値: | なし |
パイプライン入力を受け入れる: | 真 |
ワイルドカード文字を受け入れる: | False |
デフォルトでは、Write-Output
コマンドレットは常にその出力を列挙します。 NoEnumerateパラメーターはデフォルトの動作を抑制し、Write-Output
が出力を列挙しないようにします。コマンドが括弧で囲まれている場合、括弧は列挙を強制するため、NoEnumerateパラメーターは効果がありません。たとえば、(Write-Output 1,2,3)
は引き続きアレイを列挙します。
注
このスイッチは、PowerShell Core6.2以降でのみ正しく機能します。古いバージョンのPowerShellCoreでは、このスイッチを使用してもコレクションは引き続き列挙されます。
タイプ: | SwitchParameter |
位置: | 名前付き |
デフォルト値: | なし |
パイプライン入力を受け入れる: | 誤り |
ワイルドカード文字を受け入れる: | False |
入力
PSObject
できますオブジェクトをWrite-Output
にパイプします。
出力
PSObject
Write-Output
入力として送信されたオブジェクトを返します。
- about_Output_Streams
- about_Redirection
- Tee-Object
- Write-Debug
- 書き込みエラー
- 書き込みホスト
- 書き込み情報
- 書き込み進行状況
- 書き込み-詳細
- 書き込み警告