DataReceivedEventArgs.Data プロパティ

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

DataReceivedEventArgs.Data プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

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

Visual Basic (宣言)

Public ReadOnly Property
 Data As String

Visual Basic (使用法)

Dim instance As DataReceivedEventArgs
Dim value As String

value = instance.Data

C#

public string Data { get;
 }

C++

public:
property String^ Data {
    String^ get ();
}

J#

/** @property */
public String get_Data ()

JScript

public function get Data
 () : String

プロパティ値
関連する Process によって、リダイレクトされた StandardOutput または StandardError ストリームに書き込まれた行。

解説

Process の StandardOutput または StandardError ストリームをイベント ハンドラにリダイレクトすると、プロセスがリダイレクトされたストリームに行を書き込むたびに、イベントが発生します。Data プロパティは、Process がリダイレクトされた出力ストリームに書き込んだ行です。イベント ハンドラは、Data プロパティを使用して、プロセス出力をフィルタ処理したり、出力を別の場所に書き込んだりできます。たとえば、エラー出力行をすべて指定されたエラー ログ ファイルに格納するイベント ハンドラを作成できます。

1 行は、末尾にライン フィード ("\n")、またはキャリッジ リターンとライン フィード ("\r\n") が付いた一連の文字として定義されています。改行文字は、既定のシステム ANSI コード ページを使用してエンコードされます。Data プロパティには、行の終端を示す復帰またはライン フィードは含まれません。

リダイレクトされたストリームを閉じると、null 行がイベント ハンドラに送られます。イベント ハンドラが Data プロパティを適切に検証してから、このプロパティにアクセスするようにしてください。たとえば、静的メソッド String.IsNullOrEmpty を使用して、イベント ハンドラで Data プロパティを検証できます。

使用例

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

Visual Basic

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 

C#

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++

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 );
      }
   }

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataReceivedEventArgs クラス
DataReceivedEventArgs メンバ
System.Diagnostics 名前空間