RunWorkerCompletedEventArgs Klasse

Definition

Stellt Daten für das MethodNameCompleted-Ereignis bereit.Provides data for the MethodNameCompleted event.

public ref class RunWorkerCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs
public class RunWorkerCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs
type RunWorkerCompletedEventArgs = class
    inherit AsyncCompletedEventArgs
Public Class RunWorkerCompletedEventArgs
Inherits AsyncCompletedEventArgs
Vererbung
RunWorkerCompletedEventArgs

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung von RunWorkerCompletedEventArgs.The following code example illustrates the use of RunWorkerCompletedEventArgs. Dieses Beispiel ist Teil einer größeren Stichprobe für die BackgroundWorker -Klasse.This example is part of a larger sample for the BackgroundWorker class.

// This event handler deals with the results of the
// background operation.
void backgroundWorker1_RunWorkerCompleted( Object^ /*sender*/, RunWorkerCompletedEventArgs^ e )
{
   // First, handle the case where an exception was thrown.
   if ( e->Error != nullptr )
   {
      MessageBox::Show( e->Error->Message );
   }
   else
   if ( e->Cancelled )
   {
      // Next, handle the case where the user cancelled 
      // the operation.
      // Note that due to a race condition in 
      // the DoWork event handler, the Cancelled
      // flag may not have been set, even though
      // CancelAsync was called.
      resultLabel->Text = "Cancelled";
   }
   else
   {
      // Finally, handle the case where the operation 
      // succeeded.
      resultLabel->Text = e->Result->ToString();
   }

   // Enable the UpDown control.
   this->numericUpDown1->Enabled = true;

   // Enable the Start button.
   startAsyncButton->Enabled = true;

   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}
// This event handler deals with the results of the
// background operation.
private void backgroundWorker1_RunWorkerCompleted(
    object sender, RunWorkerCompletedEventArgs e)
{
    // First, handle the case where an exception was thrown.
    if (e.Error != null)
    {
        MessageBox.Show(e.Error.Message);
    }
    else if (e.Cancelled)
    {
        // Next, handle the case where the user canceled 
        // the operation.
        // Note that due to a race condition in 
        // the DoWork event handler, the Cancelled
        // flag may not have been set, even though
        // CancelAsync was called.
        resultLabel.Text = "Canceled";
    }
    else
    {
        // Finally, handle the case where the operation 
        // succeeded.
        resultLabel.Text = e.Result.ToString();
    }

    // Enable the UpDown control.
    this.numericUpDown1.Enabled = true;

    // Enable the Start button.
    startAsyncButton.Enabled = true;

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;
}
' This event handler deals with the results of the
' background operation.
Private Sub backgroundWorker1_RunWorkerCompleted( _
ByVal sender As Object, ByVal e As RunWorkerCompletedEventArgs) _
Handles backgroundWorker1.RunWorkerCompleted

    ' First, handle the case where an exception was thrown.
    If (e.Error IsNot Nothing) Then
        MessageBox.Show(e.Error.Message)
    ElseIf e.Cancelled Then
        ' Next, handle the case where the user canceled the 
        ' operation.
        ' Note that due to a race condition in 
        ' the DoWork event handler, the Cancelled
        ' flag may not have been set, even though
        ' CancelAsync was called.
        resultLabel.Text = "Canceled"
    Else
        ' Finally, handle the case where the operation succeeded.
        resultLabel.Text = e.Result.ToString()
    End If

    ' Enable the UpDown control.
    Me.numericUpDown1.Enabled = True

    ' Enable the Start button.
    startAsyncButton.Enabled = True

    ' Disable the Cancel button.
    cancelAsyncButton.Enabled = False
End Sub

Hinweise

Wenn Sie das ereignisbasierte asynchrone Muster für asynchrone Vorgänge verwenden, initiiert ein Windows Forms Formular oder ein Steuerelement einen asynchronen Vorgang durch BackgroundWorker.RunWorkerAsync Aufrufen der-Methode.When using the event-based asynchronous pattern for asynchronous operations, a Windows Forms form or control initiates an asynchronous operation by calling the BackgroundWorker.RunWorkerAsync method. Die-Methode löst wiederum das BackgroundWorker.DoWork -Ereignis asynchron aus und übergibt DoWorkEventArgs es an eine-Instanz.The method in turn raises the BackgroundWorker.DoWork event asynchronously and passes it a DoWorkEventArgs instance. Wenn der asynchrone Vorgang einen Wert zurückgibt, BackgroundWorker.DoWork weist der Ereignishandler ihn normalerweise DoWorkEventArgs.Result der-Eigenschaft zu.If the asynchronous operation returns a value, the BackgroundWorker.DoWork event handler typically assigns it to the DoWorkEventArgs.Result property. Wenn der asynchrone Vorgang abgeschlossen ist, BackgroundWorker.RunWorkerCompleted wird das-Ereignis ausgelöst, und RunWorkerCompletedEventArgs es wird eine-Instanz, die Informationen über den Status des Vorgangs enthält (ob er abgebrochen, fehlerhaft oder erfolgreich abgeschlossen wurde).When the asynchronous operation completes, the BackgroundWorker.RunWorkerCompleted event is raised and is passed a RunWorkerCompletedEventArgs instance that contains information about the status of the operation (whether it was cancelled, faulted, or completed successfully). Wenn der Vorgang erfolgreich abgeschlossen wurde Result , enthält seine-Eigenschaft den Wert, der vom asynchronen-Vorgang zurück DoWorkEventArgs.Result gegeben und zuvor der-Eigenschaft zugewiesen wurde.If it completed successfully, its Result property contains the value returned by the asynchronous operation and previously assigned to the DoWorkEventArgs.Result property.

Hinweis

Das HostProtectionAttribute auf diese Klasse angewendete-Attribut Resources besitzt den folgenden SharedState-Eigenschafts Wert:.The HostProtectionAttribute attribute applied to this class has the following Resources property value: SharedState. Das HostProtectionAttribute hat keine Auswirkungen auf Desktopanwendungen (die normalerweise durch Doppelklicken auf ein Symbol, Eingeben eines Befehls oder einer URL in einem Browser gestartet werden).The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). Weitere Informationen finden Sie unter der HostProtectionAttribute -Klasse oder SQL Server-Programmier-und Host Schutz Attributen.For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Konstruktoren

RunWorkerCompletedEventArgs(Object, Exception, Boolean)

Initialisiert eine neue Instanz der RunWorkerCompletedEventArgs-Klasse.Initializes a new instance of the RunWorkerCompletedEventArgs class.

Eigenschaften

Cancelled

Ruft einen Wert ab, der angibt, ob ein asynchroner Vorgang abgebrochen wurde.Gets a value indicating whether an asynchronous operation has been canceled.

(Geerbt von AsyncCompletedEventArgs)
Error

Ruft einen Wert ab, der angibt, welcher Fehler während eines asynchronen Vorgangs aufgetreten ist.Gets a value indicating which error occurred during an asynchronous operation.

(Geerbt von AsyncCompletedEventArgs)
Result

Ruft einen Wert ab, der das Ergebnis eines asynchronen Vorgangs darstellt.Gets a value that represents the result of an asynchronous operation.

UserState

Ruft einen Wert ab, der den Benutzerzustand darstellt.Gets a value that represents the user state.

Methoden

Equals(Object)

Ermittelt, ob das angegebene Objekt und das aktuelle Objekt gleich sind.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
RaiseExceptionIfNecessary()

Löst eine benutzerdefinierte Ausnahme aus, wenn bei einem asynchronen Vorgang ein Fehler aufgetreten ist.Raises a user-supplied exception if an asynchronous operation failed.

(Geerbt von AsyncCompletedEventArgs)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch