PowerShell で外部プロセスからの出力を変数にキャプチャするにはどうすればよいですか? 質問する

名前/パスが引用符で囲まれた個々のコマンドの前に (呼び出し演算子) を付ける必要がある&という一般的な必要性(例: $cmdOutput = & 'netdom.exe' ...-) は、外部プログラム自体には関係ありませんが (PowerShell スクリプトにも同様に適用されます)、構文の要件です。PowerShell は、引用符で囲まれた文字列で始まるステートメントを既定で式モードで解析しますが、コマンド (コマンドレット、外部プログラム、関数、エイリアス) を呼び出すには引数モードが必要であり、これが&保証されます。

$(...)と& { ... }/の主な違いは. { ... }、前者は入力をすべてメモリに収集してから全体として返すのに対し、後者は出力をストリーミングし、1 つずつのパイプライン処理に適していることです。

リダイレクトも基本的には同じように機能します (ただし、以下の注意事項を参照してください)。

$cmdOutput = <command> 2>&1 # redirect error stream (2) to success stream (1)

ただし、外部コマンドの場合、次のコマンドが期待どおりに機能する可能性が高くなります。

$cmdOutput = cmd /c <command> '2>&1' # Let cmd.exe handle redirection - see below.

外部プログラムに固有の考慮事項:

• 外部プログラムはPowerShellの型システムの外で動作するため、成功ストリーム（stdout）経由でのみ文字列を返します。同様に、PowerShellはパイプライン経由でのみ外部プログラムに文字列を送信します。 ^[1]

  • したがって、文字エンコードの問題が発生する可能性があります。

    • パイプライン経由で外部プログラムにデータを送信する場合、PowerShell は設定変数に格納されているエンコードを使用します。Windows PowerShell では既定で ASCII(!) に設定され、PowerShell [Core] では UTF-8 に設定されます。$OutVariable

    • 外部プログラムからデータを受信すると、PowerShell は に格納されているエンコードを使用して[Console]::OutputEncodingデータをデコードします。どちらの PowerShell エディションでも、既定ではシステムのアクティブなOEMコード ページが使用されます。

    • 見るこの答え詳細については;この答えシステム全体で UTF-8 を ANSI と OEM の両方のコード ページとして設定できる、まだベータ版 (この記事の執筆時点では) の Windows 10 機能について説明します。

• 出力に1 行以上含まれる場合、PowerShell は既定でそれを文字列の配列[System.Object[]]に分割します。より正確には、出力行は 1 行ずつストリーミングされ、キャプチャされると、要素が文字列 ( ) である型の配列に格納されます[System.String]。

• 出力を単一の、場合によっては複数行の文字列にしたい場合は、-join演算子を使用します (代わりに にパイプすることもできますOut-Stringが、その場合必ず末尾に改行が追加されます)。
  $cmdOutput = (<command>) -join [Environment]::NewLine

• stderrをstdout にマージして2>&1、成功ストリームの一部としてもキャプチャできるようにするには、次の注意点があります。

  • ソースでこれを実行するには、次の慣用句を使用してリダイレクトを処理します(cmd.exesh Unix 系プラットフォームでは と同様に動作します)。
    $cmdOutput = cmd /c <command> '2>&1' # *array* of strings (typically)
$cmdOutput = (cmd /c <command> '2>&1') -join "`r`n" # single string

    • cmd /ccmd.exeコマンドで呼び出し<command>、<command>完了後に終了します。

    • を囲む一重引用符に注意してください2>&1。これにより、リダイレクトがcmd.exePowerShell によって解釈されるのではなく、 に渡されることが保証されます。

    • を組み込むということは、PowerShell 独自の要件に加えて、文字をエスケープしたり環境変数を展開したりするルールがデフォルトで適用されることを意味します。PS v3+ では、 などの - スタイルの環境変数参照を除き、特別なパラメーター (いわゆる解析停止記号 ) を使用して、cmd.exe PowerShellによる残りのパラメーターの解釈をオフにすることができます。--%cmd.exe%PATH%

    • この方法ではソースでstdout と stderr をマージするため、PowerShell でstdout から生成された行と stderr から生成された行を区別できないことに注意してください。この区別が必要な場合は、PowerShell 独自の2>&1リダイレクトを使用します (以下を参照)。

  • PowerShell の リダイレクトを使用して2>&1、どの行がどのストリームから来たのかを確認します。

    • stderr出力は文字列ではなくエラー レコード( )としてキャプチャされる[System.Management.Automation.ErrorRecord]ため、出力配列には文字列(各文字列は stdout 行を表す) とエラー レコード(各レコードは stderr 行を表す)が混在する場合があります。 の要求に応じて、文字列とエラー レコードの両方が PowerShell の成功2>&1出力ストリームを介して受信されることに注意してください。

    • 注: 以下はWindows PowerShellにのみ適用されます。これらの問題はPowerShell [Core] v6+で修正されていますが、以下に示すオブジェクト タイプによるフィルタリング手法 ( $_ -is [System.Management.Automation.ErrorRecord]) も役立ちます。

    • コンソールでは、エラー レコードは赤で印刷され、デフォルトでは最初のレコードは、コマンドレットの終了しないエラーが表示されるのと同じ形式で複数行表示されます。後続のエラー レコードも赤で印刷されますが、エラーメッセージのみが1 行で印刷されます。

    • コンソールに出力する場合、通常は文字列が出力配列の最初に表示され、その後にエラー レコードが続きます (少なくとも、stdout/stderr 行のバッチ内では「同時に」出力されます)。ただし、幸い、出力をキャプチャすると、 を使用しない場合と同じ出力順序を使用して、適切にインターリーブされます2>&1。つまり、コンソールに出力する場合、キャプチャされた出力は、外部コマンドによって stdout 行と stderr 行が生成された順序を反映しません。

    • を使用して出力全体を1 つの文字列Out-Stringでキャプチャすると、 PowerShell によって余分な行が追加されますAt line:...。これは、エラー レコードの文字列表現に、場所 ( ) やカテゴリ ( )などの追加情報が含まれているためです。興味深いことに、これは最初のエラー レコード+ CategoryInfo ...にのみ適用されます。

      • この問題を回避するには、:.ToString()にパイプする代わりに、各出力オブジェクトにメソッドを適用します。PS v3+ では、次のように簡略化できます。(ボーナスとして、出力がキャプチャされない場合、コンソールに印刷する場合でも、適切にインターリーブされた出力が生成されます。)Out-String
$cmdOutput = <command> 2>&1 | % { $_.ToString() }

$cmdOutput = <command> 2>&1 | % ToString
        

      • または、エラー レコードをフィルター処理して、PowerShell のエラー ストリームに送信しますWrite-Error(ボーナスとして、出力がキャプチャされない場合でも、コンソールに印刷する場合でも、適切にインターリーブされた出力が生成されます)。

$cmdOutput = <command> 2>&1 | ForEach-Object {
  if ($_ -is [System.Management.Automation.ErrorRecord]) {
    Write-Error $_
  } else {
    $_
  }
}