Process.EnableRaisingEvents Propriedade
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém ou define se o evento Exited deve ser gerado quando o processo é encerrado.
public:
property bool EnableRaisingEvents { bool get(); void set(bool value); };
public bool EnableRaisingEvents { get; set; }
[System.ComponentModel.Browsable(false)]
public bool EnableRaisingEvents { get; set; }
member this.EnableRaisingEvents : bool with get, set
[<System.ComponentModel.Browsable(false)>]
member this.EnableRaisingEvents : bool with get, set
Public Property EnableRaisingEvents As Boolean
Valor da propriedade
true
se o evento Exited precisar ser gerado quando o processo associado for terminado (por meio de uma saída ou uma chamada a Kill()); caso contrário, false
. O padrão é false
. Observe que, mesmo que o valor de EnableRaisingEvents seja , o Exited evento será gerado pelo HasExited acessador de propriedade, se determinar que o false
processo foi encerrado.
- Atributos
Exemplos
O exemplo de código a seguir cria um processo que imprime um arquivo. Ele define a EnableRaisingEvents propriedade para fazer com que o processo gere o Exited evento quando ele for encerrado. O Exited manipulador de eventos exibe informações do processo.
using System;
using System.Diagnostics;
using System.Threading.Tasks;
class PrintProcessClass
{
private Process myProcess;
private TaskCompletionSource<bool> eventHandled;
// Print a file with any known extension.
public async Task PrintDoc(string fileName)
{
eventHandled = new TaskCompletionSource<bool>();
using (myProcess = new Process())
{
try
{
// Start a process to print a file and raise an event when done.
myProcess.StartInfo.FileName = fileName;
myProcess.StartInfo.Verb = "Print";
myProcess.StartInfo.CreateNoWindow = true;
myProcess.EnableRaisingEvents = true;
myProcess.Exited += new EventHandler(myProcess_Exited);
myProcess.Start();
}
catch (Exception ex)
{
Console.WriteLine($"An error occurred trying to print \"{fileName}\":\n{ex.Message}");
return;
}
// Wait for Exited event, but not more than 30 seconds.
await Task.WhenAny(eventHandled.Task,Task.Delay(30000));
}
}
// Handle Exited event and display process information.
private void myProcess_Exited(object sender, System.EventArgs e)
{
Console.WriteLine(
$"Exit time : {myProcess.ExitTime}\n" +
$"Exit code : {myProcess.ExitCode}\n" +
$"Elapsed time : {Math.Round((myProcess.ExitTime - myProcess.StartTime).TotalMilliseconds)}");
eventHandled.TrySetResult(true);
}
public static async Task Main(string[] args)
{
// Verify that an argument has been entered.
if (args.Length <= 0)
{
Console.WriteLine("Enter a file name.");
return;
}
// Create the process and print the document.
PrintProcessClass myPrintProcess = new PrintProcessClass();
await myPrintProcess.PrintDoc(args[0]);
}
}
Imports System.Diagnostics
Class PrintProcessClass
Private WithEvents myProcess As Process
Private eventHandled As TaskCompletionSource(Of Boolean)
' Print a file with any known extension.
Async Function PrintDoc(ByVal fileName As String) As Task
eventHandled = New TaskCompletionSource(Of Boolean)()
myProcess = New Process
Using myProcess
Try
' Start a process to print a file and raise an event when done.
myProcess.StartInfo.FileName = fileName
myProcess.StartInfo.Verb = "Print"
myProcess.StartInfo.CreateNoWindow = True
myProcess.EnableRaisingEvents = True
AddHandler myProcess.Exited, New EventHandler(AddressOf myProcess_Exited)
myProcess.Start()
Catch ex As Exception
Console.WriteLine("An error occurred trying to print ""{0}"":" &
vbCrLf & ex.Message, fileName)
Return
End Try
' Wait for Exited event, but not more than 30 seconds.
Await Task.WhenAny(eventHandled.Task, Task.Delay(30000))
End Using
End Function
' Handle Exited event and display process information.
Private Sub myProcess_Exited(ByVal sender As Object,
ByVal e As System.EventArgs)
Console.WriteLine("Exit time: {0}" & vbCrLf &
"Exit code: {1}" & vbCrLf & "Elapsed time: {2}",
myProcess.ExitTime, myProcess.ExitCode,
Math.Round((myProcess.ExitTime - myProcess.StartTime).TotalMilliseconds))
eventHandled.TrySetResult(True)
End Sub
Shared Sub Main(ByVal args As String())
' Verify that an argument has been entered.
If args.Length <= 0 Then
Console.WriteLine("Enter a file name.")
Return
End If
' Create the process and print the document.
Dim myPrintProcess As New PrintProcessClass
myPrintProcess.PrintDoc(args(0)).Wait()
End Sub
End Class
Comentários
A EnableRaisingEvents propriedade sugere se o componente deve ser notificado quando o sistema operacional tiver desligado um processo. A EnableRaisingEvents propriedade é usada no processamento assíncrono para notificar o aplicativo de que um processo foi encerrado. Para forçar seu aplicativo a aguardar de forma síncrona um evento de saída (que interrompe o processamento do aplicativo até que o evento de saída ocorra), use o WaitForExit método .
Observação
Se você estiver usando o Visual Studio e clicar duas vezes em um Process componente em seu projeto, um delegado de eventos e um Exited manipulador de eventos serão gerados automaticamente. Código adicional define a EnableRaisingEvents propriedade como false
. Você deve alterar essa propriedade para para que true
o manipulador de eventos seja executado quando o processo associado for encerrado.
Se o valor do EnableRaisingEvents componente for true
ou quando EnableRaisingEvents for false
e um HasExited marcar for invocado pelo componente, o componente poderá acessar as informações administrativas do processo associado, que permanece armazenado pelo sistema operacional. Essas informações incluem o ExitTime e o ExitCode.
Depois que o processo associado é encerrado, o Handle do componente não aponta mais para um recurso de processo existente. Em vez disso, ele só pode ser usado para acessar as informações do sistema operacional sobre o recurso de processo. O sistema operacional está ciente de que há identificadores para processos encerrados que não foram liberados pelos Process componentes, portanto, ele mantém as ExitTime informações e Handle na memória.
Há um custo associado à observação de um processo para sair. Se EnableRaisingEvents for true
, o Exited evento será gerado quando o processo associado for encerrado. Seus procedimentos para o Exited evento são executados nesse momento.
Às vezes, seu aplicativo inicia um processo, mas não requer notificação de seu fechamento. Por exemplo, seu aplicativo pode iniciar o Bloco de Notas para permitir que o usuário execute a edição de texto, mas não faça mais uso do aplicativo bloco de notas. Você pode optar por evitar a notificação quando o processo for encerrado porque ele não é relevante para a operação contínua do seu aplicativo. A configuração EnableRaisingEvents como false
pode salvar recursos do sistema.