Process.StandardOutput プロパティ

リファレンス

定義

名前空間:: System.Diagnostics

アセンブリ:: System.Diagnostics.Process.dll

アセンブリ:: System.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

アプリケーションのテキスト出力の読み取りに使用されるストリームを取得します。

public:
 property System::IO::StreamReader ^ StandardOutput { System::IO::StreamReader ^ get(); };

public System.IO.StreamReader StandardOutput { get; }

[System.ComponentModel.Browsable(false)]
public System.IO.StreamReader StandardOutput { get; }

member this.StandardOutput : System.IO.StreamReader

[<System.ComponentModel.Browsable(false)>]
member this.StandardOutput : System.IO.StreamReader

Public ReadOnly Property StandardOutput As StreamReader

プロパティ値

StreamReader

アプリケーションの標準出力ストリームの読み取りに使用できる StreamReader。

属性: BrowsableAttribute

例外

InvalidOperationException

StandardOutput ストリームがリダイレクト用に定義されていません。RedirectStandardOutput が true に設定されており、UseShellExecute が false に設定されていることを確認してください。

または

StandardOutput ストリームが、BeginOutputReadLine() を使用した非同期読み取り操作のために開いています。

例

次の例では、ipconfig.exe コマンドを実行し、その標準出力を例のコンソールウィンドウにリダイレクトします。

using namespace System;
using namespace System::IO;
using namespace System::Diagnostics;

int main()
{
    Process^ process = gcnew Process();
    process->StartInfo->FileName = "ipconfig.exe";
    process->StartInfo->UseShellExecute = false;
    process->StartInfo->RedirectStandardOutput = true;
    process->Start();

    // Synchronously read the standard output of the spawned process-> 
    StreamReader^ reader = process->StandardOutput;
    String^ output = reader->ReadToEnd();

    // Write the redirected output to this application's window.
    Console::WriteLine(output);

    process->WaitForExit();
    process->Close();

    Console::WriteLine("\n\nPress any key to exit");
    Console::ReadLine();
    return 0;
}

using System;
using System.IO;
using System.Diagnostics;

class StandardOutputExample
{
    public static void Main()
    {
        using (Process process = new Process())
        {
            process.StartInfo.FileName = "ipconfig.exe";
            process.StartInfo.UseShellExecute = false;
            process.StartInfo.RedirectStandardOutput = true;
            process.Start();

            // Synchronously read the standard output of the spawned process.
            StreamReader reader = process.StandardOutput;
            string output = reader.ReadToEnd();

            // Write the redirected output to this application's window.
            Console.WriteLine(output);

            process.WaitForExit();
        }

        Console.WriteLine("\n\nPress any key to exit.");
        Console.ReadLine();
    }
}

Imports System.IO
Imports System.Diagnostics

Module Module1
    Sub Main()
        Using process As New Process()
            process.StartInfo.FileName = "ipconfig.exe"
            process.StartInfo.UseShellExecute = False
            process.StartInfo.RedirectStandardOutput = True
            process.Start()

            ' Synchronously read the standard output of the spawned process. 
            Dim reader As StreamReader = process.StandardOutput
            Dim output As String = reader.ReadToEnd()
            Console.WriteLine(output)

            process.WaitForExit()
        End Using

        Console.WriteLine(Environment.NewLine + Environment.NewLine + "Press any key to exit.")
        Console.ReadLine()
    End Sub
End Module

注釈

Process標準ストリームにテキストを書き込むと、そのテキストは通常コンソールに表示されます。ストリームを StandardOutput リダイレクトすることで、プロセスの出力を操作または抑制できます。たとえば、テキストをフィルター処理したり、書式設定を変えたり、コンソールと指定されたログファイルの両方に出力を書き込んだりできます。

注意

使用StandardOutputするには、に設定ProcessStartInfo.UseShellExecuteするfalse必要があり、設定するtrue必要がありますProcessStartInfo.RedirectStandardOutput。それ以外の場合、ストリームからの読み取り StandardOutput では例外がスローされます。

リダイレクトされた StandardOutput ストリームは、同期的または非同期的に読み取ることができます。プロセスの出力ストリームに対して同期読み取り操作を実行する ReadToEnd 、などのRead ReadLineメソッド。これらの同期読み取り操作は、関連付けられている Process ストリームへの StandardOutput 書き込み、またはストリームを閉じるまで完了しません。

これに対し、 BeginOutputReadLine ストリームで非同期読み取り操作を StandardOutput 開始します。このメソッドは、ストリーム出力に対して指定されたイベントハンドラーを有効にし、すぐに呼び出し元に戻り、ストリーム出力がイベントハンドラーに送信されている間に他の作業を実行できます。

同期読み取り操作では、呼び出し元がストリームから読み取り、 StandardOutput そのストリームに書き込む子プロセスとの間に依存関係が発生します。これらの依存関係により、デッドロック状態が発生する可能性があります。呼び出し元が子プロセスのリダイレクトされたストリームから読み取ると、子プロセスに依存します。呼び出し元は、子がストリームに書き込むか、ストリームを閉じるまで読み取り操作を待機します。子プロセスが、リダイレクトされたストリームを満たすのに十分なデータを書き込む場合は、親に依存します。子プロセスは、親がフルストリームから読み取るか、ストリームを閉じるまで、次の書き込み操作を待機します。デッドロック状態は、呼び出し元と子プロセスが互いに操作を完了するのを待機し、どちらも続行できない場合に発生します。呼び出し元と子プロセスの間の依存関係を評価することで、デッドロックを回避できます。

このセクションの最後の 2 つの例では、メソッドを Start 使用して 、Write500Lines.exe という名前の実行可能ファイルを起動します。次の例には、そのソースコードが含まれています。

using System;
using System.IO;

public class Example3
{
   public static void Main()
   {
      for (int ctr = 0; ctr < 500; ctr++)
         Console.WriteLine($"Line {ctr + 1} of 500 written: {ctr + 1/500.0:P2}");

      Console.Error.WriteLine("\nSuccessfully wrote 500 lines.\n");
   }
}
// The example displays the following output:
//      The last 50 characters in the output stream are:
//      ' 49,800.20%
//      Line 500 of 500 written: 49,900.20%
//'
//
//      Error stream: Successfully wrote 500 lines.

Imports System.IO

Public Module Example
   Public Sub Main()
      For ctr As Integer = 0 To 499
         Console.WriteLine($"Line {ctr + 1} of 500 written: {ctr + 1/500.0:P2}")
      Next

      Console.Error.WriteLine($"{vbCrLf}Successfully wrote 500 lines.{vbCrLf}")
   End Sub
End Module
' The example displays the following output:
'      The last 50 characters in the output stream are:
'      ' 49,800.20%
'      Line 500 of 500 written: 49,900.20%
'
'
'      Error stream: Successfully wrote 500 lines.

次の例は、リダイレクトされたストリームから読み取り、子プロセスが終了するまで待機する方法を示しています。この例では、前p.WaitForExitに呼び出p.StandardOutput.ReadToEndすことでデッドロック状態を回避します。デッドロック状態は、親プロセスが前にp.StandardOutput.ReadToEnd呼び出p.WaitForExitし、子プロセスがリダイレクトされたストリームを満たすのに十分なテキストを書き込む場合に発生する可能性があります。親プロセスは、子プロセスが終了するまで無期限に待機します。子プロセスは、親がフル StandardOutput ストリームから読み取るのを無期限に待機します。

using System;
using System.Diagnostics;

public class Example2
{
   public static void Main()
   {
      var p = new Process();  
      p.StartInfo.UseShellExecute = false;  
      p.StartInfo.RedirectStandardOutput = true;  
      p.StartInfo.FileName = "Write500Lines.exe";  
      p.Start();  

      // To avoid deadlocks, always read the output stream first and then wait.  
      string output = p.StandardOutput.ReadToEnd();  
      p.WaitForExit();

      Console.WriteLine($"The last 50 characters in the output stream are:\n'{output.Substring(output.Length - 50)}'");
   }
}
// The example displays the following output:
//      Successfully wrote 500 lines.
//
//      The last 50 characters in the output stream are:
//      ' 49,800.20%
//      Line 500 of 500 written: 49,900.20%
//      '

Imports System.Diagnostics'

Public Module Example
   Public Sub Main()
      Dim p As New Process()
      p.StartInfo.UseShellExecute = False  
      p.StartInfo.RedirectStandardOutput = True  
      p.StartInfo.FileName = "Write500Lines.exe"  
      p.Start() 

      ' To avoid deadlocks, always read the output stream first and then wait.  
      Dim output As String = p.StandardOutput.ReadToEnd()  
      p.WaitForExit()

      Console.WriteLine($"The last 50 characters in the output stream are:\n'{output.Substring(output.Length - 50)}'")
   End Sub
End Module
' The example displays the following output:
'      Successfully wrote 500 lines.
'
'      The last 50 characters in the output stream are:
'      ' 49,800.20%
'      Line 500 of 500 written: 49,900.20%
'      '

標準出力ストリームと標準エラーストリームの両方からすべてのテキストを読み取ると、同様の問題が発生します。次の例では、両方のストリームに対して読み取り操作を実行します。ストリームに対して非同期読み取り操作を実行することで、デッドロック状態を StandardError 回避します。デッドロック状態は、親プロセスがその後p.StandardError.ReadToEndに呼び出p.StandardOutput.ReadToEndされ、子プロセスがそのエラーストリームを満たすのに十分なテキストを書き込む場合に発生します。親プロセスは、子プロセスが StandardOutput ストリームを閉じるのを無期限に待機します。子プロセスは、親がフル StandardError ストリームから読み取るのを無期限に待機します。

using System;
using System.Diagnostics;

public class Example
{
   public static void Main()
   {
      var p = new Process();  
      p.StartInfo.UseShellExecute = false;  
      p.StartInfo.RedirectStandardOutput = true;  
      string eOut = null;
      p.StartInfo.RedirectStandardError = true;
      p.ErrorDataReceived += new DataReceivedEventHandler((sender, e) => 
                                 { eOut += e.Data; });
      p.StartInfo.FileName = "Write500Lines.exe";  
      p.Start();  

      // To avoid deadlocks, use an asynchronous read operation on at least one of the streams.  
      p.BeginErrorReadLine();
      string output = p.StandardOutput.ReadToEnd();  
      p.WaitForExit();

      Console.WriteLine($"The last 50 characters in the output stream are:\n'{output.Substring(output.Length - 50)}'");
      Console.WriteLine($"\nError stream: {eOut}");
   }
}
// The example displays the following output:
//      The last 50 characters in the output stream are:
//      ' 49,800.20%
//      Line 500 of 500 written: 49,900.20%
//      '
//
//      Error stream: Successfully wrote 500 lines.

Imports System.Diagnostics

Public Module Example
   Public Sub Main()
      Dim p As New Process()  
      p.StartInfo.UseShellExecute = False  
      p.StartInfo.RedirectStandardOutput = True  
      Dim eOut As String = Nothing
      p.StartInfo.RedirectStandardError = True
      AddHandler p.ErrorDataReceived, Sub(sender, e) eOut += e.Data 
      p.StartInfo.FileName = "Write500Lines.exe"  
      p.Start()  

      ' To avoid deadlocks, use an asynchronous read operation on at least one of the streams.  
      p.BeginErrorReadLine()
      Dim output As String = p.StandardOutput.ReadToEnd()  
      p.WaitForExit()

      Console.WriteLine($"The last 50 characters in the output stream are:{vbCrLf}'{output.Substring(output.Length - 50)}'")
      Console.WriteLine($"{vbCrLf}Error stream: {eOut}")
   End Sub
End Module
' The example displays the following output:
'      The last 50 characters in the output stream are:
'      ' 49,800.20%
'      Line 500 of 500 written: 49,900.20%
'      '
'
'      Error stream: Successfully wrote 500 lines.

非同期読み取り操作を使用して、これらの依存関係とそのデッドロックの可能性を回避できます。または、2 つのスレッドを作成し、個別のスレッドで各ストリームの出力を読み取ることで、デッドロック状態を回避できます。

注意

リダイレクトされたストリームで非同期読み取り操作と同期読み取り操作を混在させることはできません。リダイレクトされたストリームが Process 非同期モードまたは同期モードで開かれると、そのストリームに対するそれ以降のすべての読み取り操作は同じモードである必要があります。たとえば、ストリームのStandardOutput呼び出しReadLineに従BeginOutputReadLineわないでください。またはその逆も同様です。ただし、異なるモードで 2 つの異なるストリームを読み取ることができます。たとえば、ストリームを呼び出してから呼び出 BeginOutputReadLine ReadLine StandardError すことができます。

適用対象

Process.StandardOutput プロパティ

定義

プロパティ値

例外

例

注釈

適用対象

こちらもご覧ください

その他のリソース