DoWorkEventArgs.Argument Eigenschaft

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.EventBasedAsync.dll

Quelle:

DoWorkEvent.cs

Ruft einen Wert ab, der das Argument eines asynchronen Vorgangs darstellt.

public:
 property System::Object ^ Argument { System::Object ^ get(); };

public object? Argument { get; }

member this.Argument : obj

Public ReadOnly Property Argument As Object

Eigenschaftswert

Object

Ein Object, das das Argument eines asynchronen Vorgangs darstellt.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die DoWorkEventArgs -Klasse zum Behandeln des Ereignisses DoWork verwendet wird. Eine vollständige Codeauflistung finden Sie unter Vorgehensweise: Ausführen eines Vorgangs im Hintergrund.

private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
    // Do not access the form's BackgroundWorker reference directly.
    // Instead, use the reference provided by the sender parameter.
    BackgroundWorker bw = sender as BackgroundWorker;

    // Extract the argument.
    int arg = (int)e.Argument;

    // Start the time-consuming operation.
    e.Result = TimeConsumingOperation(bw, arg);

    // If the operation was canceled by the user, 
    // set the DoWorkEventArgs.Cancel property to true.
    if (bw.CancellationPending)
    {
        e.Cancel = true;
    }
}

Private Sub backgroundWorker1_DoWork( _
sender As Object, e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

   ' Do not access the form's BackgroundWorker reference directly.
   ' Instead, use the reference provided by the sender parameter.
   Dim bw As BackgroundWorker = CType( sender, BackgroundWorker )
   
   ' Extract the argument.
   Dim arg As Integer = Fix(e.Argument)
   
   ' Start the time-consuming operation.
   e.Result = TimeConsumingOperation(bw, arg)
   
   ' If the operation was canceled by the user, 
   ' set the DoWorkEventArgs.Cancel property to true.
   If bw.CancellationPending Then
      e.Cancel = True
   End If

End Sub

Weitere Informationen

• BackgroundWorker
• How to: Ausführen eines Vorgangs im Hintergrund