Process.BeginOutputReadLine Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Avvia operazioni di lettura asincrone sul flusso di StandardOutput reindirizzato dell'applicazione.
public:
void BeginOutputReadLine();
[System.Runtime.InteropServices.ComVisible(false)]
public void BeginOutputReadLine();
public void BeginOutputReadLine();
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.BeginOutputReadLine : unit -> unit
member this.BeginOutputReadLine : unit -> unit
Public Sub BeginOutputReadLine ()
- Attributi
Eccezioni
La RedirectStandardOutput proprietà è false.
oppure
Un'operazione di lettura asincrona è già in corso nel StandardOutput flusso.
oppure
Il StandardOutput flusso è stato usato da un'operazione di lettura sincrona.
Esempio
Nell'esempio seguente viene illustrato come eseguire operazioni di lettura asincrone nel flusso reindirizzato StandardOutput del sort comando. Il sort comando è un'applicazione console che legge e ordina l'input di testo.
Nell'esempio viene creato un delegato di evento per il SortOutputHandler gestore eventi e lo associa all'evento OutputDataReceived . Il gestore eventi riceve righe di testo dal flusso reindirizzato StandardOutput , formatta il testo e scrive il testo sullo schermo.
// 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 = 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 += 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 = {numOutputLines} sorted text line(s) ");
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}] - {outLine.Data}");
}
}
}
}
namespace ProcessAsyncStreamSamples
{
class ProcessSampleMain
{
/// The main entry point for the application.
static void Main()
{
try
{
SortOutputRedirection.SortInputListText();
}
catch (InvalidOperationException e)
{
Console.WriteLine("Exception:");
Console.WriteLine(e);
}
}
}
}
// Define the namespaces used by this sample.
open System
open System.Text
open System.Diagnostics
// Define variables shared by class methods.
let mutable sortOutput = StringBuilder()
let mutable numOutputLines = 0;
let sortOutputHandler (sendingProcess: obj) (outLine: DataReceivedEventArgs) =
// Collect the sort command output.
if String.IsNullOrEmpty outLine.Data |> not then
numOutputLines <- numOutputLines + 1
// Add the text to the collected output.
sortOutput.Append(Environment.NewLine + $"[{numOutputLines}] - {outLine.Data}") |> ignore
let sortInputListText () =
// Initialize the process and its StartInfo properties.
// The sort command is a console application that
// reads and sorts text input.
let 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 <- StringBuilder();
// Set our event handler to asynchronously read the sort output.
sortProcess.OutputDataReceived.AddHandler sortOutputHandler
// Redirect standard input as well. This stream
// is used synchronously.
sortProcess.StartInfo.RedirectStandardInput <- true;
// Start the process.
sortProcess.Start() |> ignore
// Use a stream writer to synchronously write the sort input.
let 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.
printfn "Ready to sort up to 50 lines of text"
let mutable inputText = ""
let mutable numInputLines = 0
while String.IsNullOrEmpty inputText do
printfn "Enter a text line (or press the Enter key to stop):"
inputText <- Console.ReadLine()
if String.IsNullOrEmpty inputText |> not then
numInputLines <- numInputLines + 1
sortStreamWriter.WriteLine inputText
printfn "<end of input stream>\n"
// 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 then
// Write the formatted and sorted output to the console.
printfn $" Sort results = {numOutputLines} sorted text line(s) "
printfn "----------"
printfn $"{sortOutput}"
else
printfn " No input lines were sorted."
sortProcess.Close();
// The main entry point for the application.
do
try
sortInputListText ()
with :? InvalidOperationException as e ->
printfn "Exception:"
printfn $"{e}"
' Define the namespaces used by this sample.
Imports System.Text
Imports System.IO
Imports System.Diagnostics
Imports System.Threading
Imports System.ComponentModel
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 = {numOutputLines} sorted text line(s) ")
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}] - {outLine.Data}")
End If
End Sub
End Class
End Namespace
Namespace ProcessAsyncStreamSamples
Class ProcessSampleMain
' The main entry point for the application.
Shared Sub Main()
Try
ProcessAsyncOutputRedirection.SortInputListText()
Catch e As InvalidOperationException
Console.WriteLine("Exception:")
Console.WriteLine(e)
End Try
End Sub
End Class 'ProcessSampleMain
End Namespace 'Process_AsyncStream_Sample
Commenti
Il StandardOutput flusso può essere letto in modo sincrono o asincrono. Metodi come Read, ReadLineed eseguono ReadToEnd operazioni di lettura sincrone sul flusso di output del processo. Queste operazioni di lettura sincrone non vengono completate fino a quando le scritture associate nel Process flusso StandardOutput non vengono completate o chiude il flusso.
Al contrario, BeginOutputReadLine avvia operazioni di lettura asincrone nel StandardOutput flusso. Questo metodo abilita un gestore eventi designato per l'output del flusso e torna immediatamente al chiamante, che può eseguire altre operazioni mentre l'output del flusso viene indirizzato al gestore eventi.
Seguire questa procedura per eseguire operazioni di lettura asincrone su StandardOutput per un Process oggetto :
Impostare UseShellExecute su
false.Impostare RedirectStandardOutput su
true.Aggiungere il gestore eventi all'evento OutputDataReceived . Il gestore eventi deve corrispondere alla firma del System.Diagnostics.DataReceivedEventHandler delegato.
Avviare il Process.
Chiamare BeginOutputReadLine per .Process Questa chiamata avvia operazioni di lettura asincrone su StandardOutput.
All'avvio delle operazioni di lettura asincrone, il gestore eventi viene chiamato ogni volta che l'oggetto associato Process scrive una riga di testo nel flusso StandardOutput .
È possibile annullare un'operazione di lettura asincrona chiamando CancelOutputRead. L'operazione di lettura può essere annullata dal chiamante o dal gestore eventi. Dopo l'annullamento, è possibile chiamare BeginOutputReadLine di nuovo per riprendere le operazioni di lettura asincrone.
Note
Non è possibile combinare operazioni di lettura asincrone e sincrone in un flusso reindirizzato. Una volta aperto il flusso reindirizzato di un oggetto Process in modalità asincrona o sincrona, tutte le operazioni di lettura aggiuntive su tale flusso devono trovarsi nella stessa modalità. Ad esempio, non seguire BeginOutputReadLine con una chiamata a ReadLine sul StandardOutput flusso o viceversa. Tuttavia, è possibile leggere due flussi diversi in modalità diverse. Ad esempio, è possibile chiamare e quindi chiamare BeginOutputReadLineReadLine per il StandardError flusso.