Process.BeginOutputReadLine Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Zahájí asynchronní operace čtení u přesměrovaného StandardOutput datového proudu aplikace.
public:
void BeginOutputReadLine();public void BeginOutputReadLine();[System.Runtime.InteropServices.ComVisible(false)]
public void BeginOutputReadLine();member this.BeginOutputReadLine : unit -> unit[<System.Runtime.InteropServices.ComVisible(false)>]
member this.BeginOutputReadLine : unit -> unitPublic Sub BeginOutputReadLine ()- Atributy
Výjimky
Vlastnost RedirectStandardOutput je false.
nebo
Asynchronní operace čtení již probíhá ve streamu StandardOutput .
nebo
Stream StandardOutput byl používán synchronní operací čtení.
Příklady
Následující příklad ukazuje, jak provádět asynchronní operace čtení u přesměrovaného StandardOutput datového sort proudu příkazu. Příkaz sort je konzolová aplikace, která čte a seřadí textový vstup.
Příklad vytvoří delegáta události pro obslužnou rutinu SortOutputHandler události a přidruží ji k OutputDataReceived události. Obslužná rutina události přijímá textové řádky z přesměrovaného StandardOutput datového proudu, formátuje text a zapíše text na obrazovku.
// 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
Poznámky
Stream StandardOutput je možné číst synchronně nebo asynchronně. Metody, jako Readje , ReadLinea ReadToEnd provádět synchronní operace čtení ve výstupním datovém proudu procesu. Tyto synchronní operace čtení se nedokončí, dokud přidružené Process zápisy do jeho StandardOutput datového proudu nebo nezavře datový proud.
Naproti tomu BeginOutputReadLine spouští asynchronní operace čtení ve streamu StandardOutput . Tato metoda umožňuje určenou obslužnou rutinu události pro výstup streamu a okamžitě se vrátí volajícímu, který může provádět další práci, zatímco výstup streamu je směrován na obslužnou rutinu události.
Při provádění asynchronních operací StandardOutput čtení pro Process :
Nastavte UseShellExecute na hodnotu
false.Nastavte RedirectStandardOutput na hodnotu
true.Přidejte do události obslužnou rutinu OutputDataReceived události. Obslužná rutina události musí odpovídat podpisu delegáta System.Diagnostics.DataReceivedEventHandler .
Spusťte tlačítko Process.
Zavolejte BeginOutputReadLine .Process Toto volání spouští asynchronní operace čtení na StandardOutput.
Při spuštění asynchronních operací čtení se obslužná rutina události volá pokaždé, když přidružená Process zapíše řádek textu do streamu StandardOutput .
Asynchronní operaci čtení můžete zrušit voláním CancelOutputRead. Operaci čtení může volající nebo obslužná rutina události zrušit. Po zrušení můžete znovu volat BeginOutputReadLine , abyste obnovili asynchronní operace čtení.
Note
Asynchronní a synchronní operace čtení u přesměrovaného datového proudu nelze kombinovat. Po otevření přesměrovaného streamu Process v asynchronním nebo synchronním režimu musí být všechny další operace čtení v daném datovém proudu ve stejném režimu. Například nespočítejte BeginOutputReadLine s voláním ReadLine do datového StandardOutput proudu nebo naopak. Můžete ale číst dva různé streamy v různých režimech. Můžete například volat BeginOutputReadLine a volat ReadLine pro StandardError stream.
