DataReceivedEventArgsとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

DataReceivedEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

OutputDataReceived イベントと ErrorDataReceived イベントのデータを提供します。

名前空間: System.Diagnostics
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class DataReceivedEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As DataReceivedEventArgs

public class DataReceivedEventArgs : EventArgs

C++

public ref class DataReceivedEventArgs : public
 EventArgs

public class DataReceivedEventArgs extends
 EventArgs

JScript

public class DataReceivedEventArgs extends
 EventArgs

解説

プロセスのリダイレクトされた StandardOutput または StandardError ストリーム出力を非同期に収集するには、リダイレクトされたストリーム出力イベントを処理するメソッドを作成する必要があります。プロセスがリダイレクトされたストリームに書き込むときに、イベントハンドラメソッドが呼び出されます。イベントデリゲートは、DataReceivedEventArgs のインスタンスと共にイベントハンドラを呼び出します。Data プロパティには、プロセスがリダイレクトされたストリームに書き込んだテキスト行が格納されます。

使用例

sort コマンドのリダイレクトされた StandardOutput ストリームで、非同期読み取り操作を実行するコード例を次に示します。sort コマンドは、テキスト入力を読み込み、並べ替えを実行するコンソールアプリケーションです。

この例では、SortOutputHandler イベントハンドラのイベントデリゲートを作成して、OutputDataReceived イベントに関連付けます。イベントハンドラは、リダイレクトされた StandardOutput ストリームからテキスト行を受け取った後、そのテキストに書式を設定して画面に出力します。

Visual Basic

' Define the namespaces used by this sample.
Imports System
Imports System.Text
Imports System.IO
Imports System.Diagnostics
Imports System.Threading
Imports System.ComponentModel
Imports Microsoft.VisualBasic

Namespace ProcessAsyncStreamSamples
   
   Class ProcessAsyncOutputRedirection
      ' Define static variables shared by class methods.
      Private Shared sortOutput As
 StringBuilder = Nothing
      Private Shared numOutputLines As
 Integer = 0
      
      Public Shared Sub
 SortInputListText()
         
         ' Initialize the process and its StartInfo properties.
         ' The sort command is a console application that
         ' reads and sorts text input.
         Dim sortProcess As New
 Process()
         sortProcess.StartInfo.FileName = "Sort.exe"
         
         ' Set UseShellExecute to false for redirection.
         sortProcess.StartInfo.UseShellExecute = False
         
         ' Redirect the standard output of the sort command.  
         ' Read the stream asynchronously using an event handler.
         sortProcess.StartInfo.RedirectStandardOutput = True
         sortOutput = new StringBuilder()

         ' Set our event handler to asynchronously read the sort output.
         AddHandler sortProcess.OutputDataReceived, _
                    AddressOf SortOutputHandler
         
         ' Redirect standard input as well.  This stream
         ' is used synchronously.
         sortProcess.StartInfo.RedirectStandardInput = True
         
         ' Start the process.
         sortProcess.Start()
         
         ' Use a stream writer to synchronously write the sort input.
         Dim sortStreamWriter As StreamWriter
 = sortProcess.StandardInput
     
         ' Start the asynchronous read of the sort output stream.
         sortProcess.BeginOutputReadLine()
         
         ' Prompt the user for input text lines.  Write each 
         ' line to the redirected input stream of the sort command.
         Console.WriteLine("Ready to sort up to 50 lines of text")
         
         Dim inputText As String
         Dim numInputLines As Integer
 = 0
         Do
            Console.WriteLine("Enter a text line (or press the
 Enter key to stop):")
            
            inputText = Console.ReadLine()
            If Not String.IsNullOrEmpty(inputText)
 Then
               numInputLines += 1
               sortStreamWriter.WriteLine(inputText)
            End If
         Loop While Not
 String.IsNullOrEmpty(inputText) AndAlso numInputLines
 < 50
         Console.WriteLine("<end of input stream>")
         Console.WriteLine()
         
         ' End the input stream to the sort command.
         sortStreamWriter.Close()
         
         ' Wait for the sort process to write the sorted text lines.
         sortProcess.WaitForExit()
         
         If Not String.IsNullOrEmpty(numOutputLines)
 Then
            ' Write the formatted and sorted output to the console.
            Console.WriteLine(" Sort results = {0} sorted text
 line(s) ", _
                              numOutputLines)
            Console.WriteLine("----------")
            Console.WriteLine(sortOutput)
         Else
            Console.WriteLine(" No input lines were sorted.")
         End If
         
         sortProcess.Close()
      End Sub 
      
      Private Shared Sub
 SortOutputHandler(sendingProcess As Object,
 _
         outLine As DataReceivedEventArgs)

         ' Collect the sort command output.
         If Not String.IsNullOrEmpty(outLine.Data)
 Then
            numOutputLines += 1
            
            ' Add the text to the collected output.
            sortOutput.Append(Environment.NewLine + "["
 _
                         + numOutputLines.ToString() + "] - "
 _
                         + outLine.Data)
         End If
      End Sub 
   End Class  
End Namespace

// Define the namespaces used by this sample.
using System;
using System.Text;
using System.IO;
using System.Diagnostics;
using System.Threading;
using System.ComponentModel;

namespace ProcessAsyncStreamSamples
{
    class SortOutputRedirection
    {
        // Define static variables shared by class methods.
        private static StringBuilder sortOutput
 = null;
        private static int
 numOutputLines = 0;
      
        public static void
 SortInputListText()
        {
            // Initialize the process and its StartInfo properties.
            // The sort command is a console application that
            // reads and sorts text input.

            Process sortProcess;
            sortProcess = new Process();
            sortProcess.StartInfo.FileName = "Sort.exe";
            
            // Set UseShellExecute to false for redirection.
            sortProcess.StartInfo.UseShellExecute = false;

            // Redirect the standard output of the sort command.  
            // This stream is read asynchronously using an event handler.
            sortProcess.StartInfo.RedirectStandardOutput = true;
            sortOutput = new StringBuilder("");

            // Set our event handler to asynchronously read the sort
 output.
            sortProcess.OutputDataReceived += new DataReceivedEventHandler(SortOutputHandler);

            // Redirect standard input as well.  This stream
            // is used synchronously.
            sortProcess.StartInfo.RedirectStandardInput = true;
  
            // Start the process.
            sortProcess.Start();

            // Use a stream writer to synchronously write the sort input.
            StreamWriter sortStreamWriter = sortProcess.StandardInput;

            // Start the asynchronous read of the sort output stream.
            sortProcess.BeginOutputReadLine();

            // Prompt the user for input text lines.  Write each 
            // line to the redirected input stream of the sort command.
            Console.WriteLine("Ready to sort up to 50 lines of text");

            String inputText;
            int numInputLines = 0;
            do 
            {
                Console.WriteLine("Enter a text line (or press the Enter key
 to stop):");
            
                inputText = Console.ReadLine();
                if (!String.IsNullOrEmpty(inputText))
                {
                    numInputLines ++;
                    sortStreamWriter.WriteLine(inputText);
                }
            }
            while (!String.IsNullOrEmpty(inputText) &&
 (numInputLines < 50));
            Console.WriteLine("<end of input stream>");
            Console.WriteLine();

            // End the input stream to the sort command.
            sortStreamWriter.Close();

            // Wait for the sort process to write the sorted text lines.
            sortProcess.WaitForExit();

            if (numOutputLines > 0)
            {
                // Write the formatted and sorted output to the console.
                Console.WriteLine(" Sort results = {0} sorted text line(s) ",
 
                    numOutputLines);
                Console.WriteLine("----------");
                Console.WriteLine(sortOutput);
            }
            else 
            {
                Console.WriteLine(" No input lines were sorted.");
            }

            sortProcess.Close();
        }

        private static void
 SortOutputHandler(object sendingProcess, 
            DataReceivedEventArgs outLine)
        {
            // Collect the sort command output.
            if (!String.IsNullOrEmpty(outLine.Data))
            {
                numOutputLines++;
    
                // Add the text to the collected output.
                sortOutput.Append(Environment.NewLine + 
                    "[" + numOutputLines.ToString() + "] - "
 + outLine.Data);
            }
        }
    }
}

C++

// Define the namespaces used by this sample.
#using <System.dll>

using namespace System;
using namespace System::Text;
using namespace System::IO;
using namespace System::Diagnostics;
using namespace System::Threading;
using namespace System::ComponentModel;

ref class SortOutputRedirection
{
private:
   // Define static variables shared by class methods.
   static StringBuilder^ sortOutput = nullptr;
   static int numOutputLines = 0;

public:
   static void SortInputListText()
   {
      // Initialize the process and its StartInfo properties.
      // The sort command is a console application that
      // reads and sorts text input.

      Process^ sortProcess;
      sortProcess = gcnew Process;
      sortProcess->StartInfo->FileName = "Sort.exe";
      
      // Set UseShellExecute to false for redirection.
      sortProcess->StartInfo->UseShellExecute = false;
      
      // Redirect the standard output of the sort command.  
      // This stream is read asynchronously using an event handler.
      sortProcess->StartInfo->RedirectStandardOutput = true;
      sortOutput = gcnew StringBuilder;
      
      // Set our event handler to asynchronously read the sort output.
      sortProcess->OutputDataReceived += gcnew DataReceivedEventHandler( SortOutputHandler
 );
      
      // Redirect standard input as well.  This stream
      // is used synchronously.
      sortProcess->StartInfo->RedirectStandardInput = true;
      
      // Start the process.
      sortProcess->Start();
      
      // Use a stream writer to synchronously write the sort input.
      StreamWriter^ sortStreamWriter = sortProcess->StandardInput;
      
      // Start the asynchronous read of the sort output stream.
      sortProcess->BeginOutputReadLine();
      
      // Prompt the user for input text lines.  Write each 
      // line to the redirected input stream of the sort command.
      Console::WriteLine( "Ready to sort up to 50 lines of text" );

      String^ inputText;
      int numInputLines = 0;
      do
      {
         Console::WriteLine( "Enter a text line (or press the Enter key to stop):"
 );

         inputText = Console::ReadLine();
         if (  !String::IsNullOrEmpty( inputText ) )
         {
            numInputLines++;
            sortStreamWriter->WriteLine( inputText );
         }
      }
      while (  !String::IsNullOrEmpty( inputText ) &&
 (numInputLines < 50) );

      Console::WriteLine( "<end of input stream>" );
      Console::WriteLine();
      
      // End the input stream to the sort command.
      sortStreamWriter->Close();
      
      // Wait for the sort process to write the sorted text lines.
      sortProcess->WaitForExit();

      if ( numOutputLines > 0 )
      {
         
         // Write the formatted and sorted output to the console.
         Console::WriteLine( " Sort results = {0} sorted text line(s) "
,
            numOutputLines.ToString() );
         Console::WriteLine( "----------" );
         Console::WriteLine( sortOutput->ToString() );
      }
      else
      {
         Console::WriteLine( " No input lines were sorted." );
      }

      sortProcess->Close();
   }

private:
   static void SortOutputHandler( Object^ /*sendingProcess*/
,
      DataReceivedEventArgs^ outLine )
   {
      // Collect the sort command output.
      if (  !String::IsNullOrEmpty( outLine->Data ) )
      {
         numOutputLines++;
         
         // Add the text to the collected output.
         sortOutput->AppendFormat( "\n[{0}] {1}",
            numOutputLines.ToString(), outLine->Data );
      }
   }
};

継承階層

System.Object
System.EventArgs
System.Diagnostics.DataReceivedEventArgs

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataReceivedEventArgs メンバ
System.Diagnostics 名前空間
DataReceivedEventHandler
Process.OutputDataReceived
Process.ErrorDataReceived
System.Diagnostics.Process

DataReceivedEventArgs プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	Data	リダイレクトされた Process 出力ストリームに書き込まれた文字の行を取得します。

参照

DataReceivedEventArgs メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

DataReceivedEventArgs メンバ

OutputDataReceived イベントと ErrorDataReceived イベントのデータを提供します。

DataReceivedEventArgs データ型で公開されるメンバを以下の表に示します。

パブリックプロパティ

	名前	説明
	Data	リダイレクトされた Process 出力ストリームに書き込まれた文字の行を取得します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)