Write-Output

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

指定したオブジェクトをパイプラインに書き込みます。 がパイプラインの最後のコマンドの場合 Write-Output 、オブジェクトがコンソールに表示されます。

構文

Write-Output
     [-InputObject] <PSObject[]>
     [-NoEnumerate]
     [<CommonParameters>]

説明

指定したオブジェクトをパイプラインに書き込みます。 がパイプラインの最後のコマンドの場合 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-OutputNoEnumerate パラメーターを使用して、パイプラインを単一のオブジェクトとしてコレクションを渡すためにも使用できます。

例

例 1: オブジェクトを取得してコンソールに書き込む

この例では、 コマンドレットの結果が Get-Process 変数に $P 格納されます。 コマンドレットは Write-Output 、 のプロセス オブジェクト $P をコンソールに表示します。

$P = Get-Process
Write-Output $P

例 2: 別のコマンドレットに出力を渡す

このコマンドは、"test output" 文字列を Get-Member コマンドレットにパイプします。このコマンドレットでは、 System.String クラスのメンバーが表示され、パイプラインに沿って文字列が渡されたことを示します。

Write-Output "test output" | Get-Member

例 3: 出力の列挙を抑制する

このコマンドは、パイプラインを通じてコレクションまたは配列を 1 つのオブジェクトとして扱うために NoEnumerate パラメーターを追加します。

Write-Output 1,2,3 | Measure-Object

Count    : 3
...

Write-Output 1,2,3 -NoEnumerate | Measure-Object

Count    : 1
...

パラメーター

-InputObject

パイプラインに送信するオブジェクトを指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。

Type:PSObject[]
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-NoEnumerate

既定では、コマンドレットは Write-Output 常にその出力を列挙します。 NoEnumerate パラメーターは既定の動作を抑制し、出力の列挙を防止Write-Outputします。 コマンドがかっこで囲まれている場合、かっこが強制的に列挙されるため、 NoEnumerate パラメーターは無効です。 たとえば、 (Write-Output 1,2,3) は配列を列挙します。

NoEnumerate パラメーターは、パイプライン内でのみ役立ちます。 コンソールで NoEnumerate の効果を確認しようとすると、PowerShell がすべてのコマンド ラインの末尾に追加 Out-Default され、列挙が発生するため、問題があります。 ただし、別のコマンドレットにパイプ Write-Output -NoEnumerate すると、ダウンストリーム コマンドレットはコレクションの列挙項目ではなく、コレクション オブジェクトを受け取ります。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

オブジェクトをこのコマンドレットにパイプできます。

出力

PSObject

このコマンドレットは、入力として送信されたオブジェクトを返します。

メモ

PowerShell には、 の次のエイリアスが Write-Output含まれています。

  • すべてのプラットフォーム:

    • echo

  • Windows の場合:

    • write