IAsyncResult.IsCompleted Propriété

Définition

Espace de noms:

System

Assemblys:

netstandard.dll, System.Runtime.dll

Source:

IAsyncResult.cs

Obtient une valeur qui indique si l’opération asynchrone est terminée.

public:
 property bool IsCompleted { bool get(); };

public bool IsCompleted { get; }

member this.IsCompleted : bool

Public ReadOnly Property IsCompleted As Boolean

Valeur de propriété

Boolean

true si l’opération est terminée ; sinon, false.

Exemples

L’exemple suivant montre comment utiliser la IsCompleted propriété de l’instance IAsyncResult pour découvrir quand un appel asynchrone se termine. Dans ce cas, l’appel asynchrone est effectué à l’aide de la BeginInvoke méthode d’un délégué. Vous pouvez utiliser la IsCompleted propriété pour interroger la saisie semi-automatique lors de l’exécution de l’appel asynchrone à partir d’un thread qui services l’interface utilisateur. L’interrogation pour connaître l’état d’avancement permet au thread appelant de continuer à s’exécuter pendant que l’appel asynchrone s’exécute sur un thread ThreadPool .

L’exemple se compose de deux classes : la classe qui contient la méthode appelée de manière asynchrone et la classe qui contient la Main méthode qui effectue l’appel.

Pour plus d’informations et d’autres exemples d’appel de méthodes de manière asynchrone à l’aide de délégués, consultez Appel asynchrone de méthodes synchrones.

using System;
using System.Threading;

namespace Examples.AdvancedProgramming.AsynchronousOperations
{
    public class AsyncDemo
    {
        // The method to be executed asynchronously.
        public string TestMethod(int callDuration, out int threadId)
        {
            Console.WriteLine("Test method begins.");
            Thread.Sleep(callDuration);
            threadId = Thread.CurrentThread.ManagedThreadId;
            return String.Format("My call time was {0}.", callDuration.ToString());
        }
    }
    // The delegate must have the same signature as the method
    // it will call asynchronously.
    public delegate string AsyncMethodCaller(int callDuration, out int threadId);
}

Imports System.Threading
Imports System.Runtime.InteropServices 

Namespace Examples.AdvancedProgramming.AsynchronousOperations
    Public Class AsyncDemo 
        ' The method to be executed asynchronously.
        Public Function TestMethod(ByVal callDuration As Integer, _
                <Out> ByRef threadId As Integer) As String
            Console.WriteLine("Test method begins.")
            Thread.Sleep(callDuration)
            threadId = Thread.CurrentThread.ManagedThreadId()
            return String.Format("My call time was {0}.", callDuration.ToString())
        End Function
    End Class

    ' The delegate must have the same signature as the method
    ' it will call asynchronously.
    Public Delegate Function AsyncMethodCaller(ByVal callDuration As Integer, _
        <Out> ByRef threadId As Integer) As String
End Namespace

using System;
using System.Threading;

namespace Examples.AdvancedProgramming.AsynchronousOperations
{
    public class AsyncMain
    {
        static void Main() {
            // The asynchronous method puts the thread id here.
            int threadId;

            // Create an instance of the test class.
            AsyncDemo ad = new AsyncDemo();

            // Create the delegate.
            AsyncMethodCaller caller = new AsyncMethodCaller(ad.TestMethod);

            // Initiate the asychronous call.
            IAsyncResult result = caller.BeginInvoke(3000,
                out threadId, null, null);

            // Poll while simulating work.
            while(!result.IsCompleted) {
                Thread.Sleep(250);
                Console.Write(".");
            }

            // Call EndInvoke to retrieve the results.
            string returnValue = caller.EndInvoke(out threadId, result);

            Console.WriteLine("\nThe call executed on thread {0}, with return value \"{1}\".",
                threadId, returnValue);
        }
    }
}

/* This example produces output similar to the following:

Test method begins.
.............
The call executed on thread 3, with return value "My call time was 3000.".
 */

Imports System.Threading
Imports System.Runtime.InteropServices 

Namespace Examples.AdvancedProgramming.AsynchronousOperations

    Public Class AsyncMain 
        Shared Sub Main() 
            ' The asynchronous method puts the thread id here.
            Dim threadId As Integer

            ' Create an instance of the test class.
            Dim ad As New AsyncDemo()

            ' Create the delegate.
            Dim caller As New AsyncMethodCaller(AddressOf ad.TestMethod)
       
            ' Initiate the asynchronous call.
            Dim result As IAsyncResult = caller.BeginInvoke(3000, _
                threadId, Nothing, Nothing)

            ' Poll while simulating work.
            While result.IsCompleted = False
                Thread.Sleep(250)
                Console.Write(".")
            End While

            ' Call EndInvoke to retrieve the results.
            Dim returnValue As String = caller.EndInvoke(threadId, result)

            Console.WriteLine(vbCrLf & _
                "The call executed on thread {0}, with return value ""{1}"".", _
                threadId, returnValue)
        End Sub
    End Class
End Namespace

' This example produces output similar to the following:
'
'Test method begins.
'.............
'The call executed on thread 3, with return value "My call time was 3000.".

Remarques

Lorsque cette propriété est true, vous pouvez supposer qu’il est sûr d’ignorer les ressources que vous allouez pour une utilisation par l’opération asynchrone.

Notes pour les responsables de l’implémentation

Les implémenteurs retournent généralement la valeur d’un champ privé ou d’un test interne comme valeur de cette propriété.

Notes pour les appelants

Les clients qui interrogent l’état de l’opération (par opposition à l’attente d’un objet de synchronisation) utilisent cette propriété pour déterminer l’état de l’opération.