Compartir a través de

IAsyncAction Interfaz

  • Referencia

Definición

Espacio de nombres:
Windows.Foundation
Editar

Representa una acción asincrónica. Este es el tipo de valor devuelto para muchos métodos asincrónicos de Windows Runtime (WinRT) que no tienen un objeto de resultado y no notifican el progreso continuo.

public interface class IAsyncAction : IAsyncInfo
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.FoundationContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(1516535814, 33850, 19881, 134, 91, 157, 38, 229, 223, 173, 123)]
struct IAsyncAction : IAsyncInfo
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.FoundationContract), 65536)]
[Windows.Foundation.Metadata.Guid(1516535814, 33850, 19881, 134, 91, 157, 38, 229, 223, 173, 123)]
public interface IAsyncAction : IAsyncInfo
Public Interface IAsyncAction
Implements IAsyncInfo
Derivado
Atributos
ContractVersionAttribute GuidAttribute
Implementaciones
IAsyncInfo

Requisitos de Windows

Familia de dispositivos
Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract
Windows.Foundation.FoundationContract (se introdujo en la versión v1.0)

Comentarios

IAsyncAction es el tipo de valor devuelto para todos los métodos asincrónicos de WinRT que no comunican un objeto de resultado o el progreso continuo. Esto constituye más de 300 API de WinRT diferentes. Las API que notifican el progreso, pero que no tienen un resultado usan otra interfaz, IAsyncActionWithProgress.

Cuando usas métodos que devuelven IAsyncAction en el código de la aplicación, normalmente no accedes al valor devuelto IAsyncAction directamente. Esto se debe a que casi siempre usa la sintaxis awaitable específica del lenguaje. En este caso, el valor devuelto aparente del método es void. Para obtener más información, consulta programación asincrónicao una de las guías específicas del lenguaje para la programación asincrónica de WinRT (Llamar a API asincrónicas en C# o Visual Basic, de C++ JavaScript).

IAsyncAction también es un tipo de entrada para algunas API de utilidad de escenario avanzado, como CoreDispatcher.RunAsync y ThreadPool.RunAsync.

No es habitual usar IAsyncAction directamente incluso si no se usa una sintaxis await específica del lenguaje. Cada uno de los idiomas tiene puntos de extensión que generalmente son más fáciles de usar que la interfaz winRT. JavaScript tiene WinJS.Promisey la sintaxis then/done. .NET tiene el método de extensión asTask y, una vez que el se convierte en un Task, es más fácil cancelar, obtener notificaciones al finalizar, etc. Para C++/CX, puede encapsular las llamadas mediante el de tiempo de ejecución de simultaneidad de (y usar create_task). En otras palabras, IAsyncAction se puede considerar infraestructura de nivel de tiempo de ejecución, que cada uno de los lenguajes usa como marco para admitir la sintaxis esperada o los modelos de programación asincrónicos de su propia manera.

En lugar de usar IAsyncAction, algunos métodos asincrónicos de WinRT usan tipos de acción personalizados (que podrían tener "Operation" en lugar de "Action" en su nombre). Por ejemplo, signOutUserOperation es un tipo winRT que implementa IAsyncAction. A continuación, el tipo signOutUserOperation de se usa como tipo de valor devuelto de acción personalizada para el método signOutUserAsync de .

Si tiene un método que devuelve un Task de .NET y necesita un IAsyncAction para pasar a una API de WinRT, puede usar el método de extensión AsAsyncAction.

Funciones de extensión de C++/WinRT

Nota

Existen funciones de extensión en los tipos de proyección de C++/WinRT para determinadas API de WinRT. Por ejemplo, winrt::Windows::Foundation::IAsyncAction es el tipo de proyección C++/WinRT para IAsyncAction. Las funciones de extensión no forman parte de la superficie de la interfaz binaria de la aplicación (ABI) de los tipos de WinRT reales, por lo que no se enumeran como miembros de las API de WinRT. Pero puede llamarlos desde cualquier proyecto de C++/WinRT. Consulta funciones de C++/WinRT que amplían las API de Windows Runtime.

void get() const;

Espera sincrónicamente a que se complete la acción. Produce una excepción correspondiente si se cancela la acción o especifica un estado de error. No debe llamarlo desde un apartamento de un solo subproceso. Para obtener más información y ejemplos de código que muestran cómo llamar a get, vea Escribir una corrutina.

AsyncStatus wait_for(TimeSpan const& timeout) const;

Espera sincrónicamente para que se complete la acción o para el tiempo de espera especificado. Devuelve el estado del IAsyncActiono AsyncStatus::Started si ha transcurrido el tiempo de espera. Si la acción no agotó el tiempo de espera, llame a GetResults para obtener los resultados de la acción. Para obtener más información y ejemplos de código que muestran cómo llamar a wait_for, consulte tiempos de espera asincrónicos que facilitan la.

Herencia de interfaz

IAsyncAction hereda IAsyncInfo . Los tipos que implementan IAsyncAction también implementan los miembros de interfaz de IAsyncInfo:

  • Método Cancel
  • método Close
  • Propiedad ErrorCode de
  • propiedad id. de
  • propiedad Status

Notas para los implementadores

Al igual que con la llamada a los métodos existentes, hay formas específicas del lenguaje para definir métodos asincrónicos que no usan IAsyncInfo directamente. Si escribe código mediante .NET, el método puede devolver un Task. Para C++/CX, puede usar el entorno de ejecución de simultaneidad de . Sin embargo, si va a definir un componente de , puede usar Task/task internamente, pero debe devolver una de las interfaces de WinRT para los métodos públicos. Los tipos de soporte asincrónico específicos del lenguaje (y muchos otros tipos específicos del lenguaje que podría usar convencionalmente en el código) no se pueden usar para el área expuesta pública de un componente de WinRT.

Propiedades

Completed

Obtiene o establece el delegado al que se llama cuando se completa la acción.
ErrorCode

Obtiene una cadena que describe una condición de error de la operación asincrónica.

(Heredado de IAsyncInfo)
Id

Obtiene el identificador de la operación asincrónica.

(Heredado de IAsyncInfo)
Status

Obtiene un valor que indica el estado de la operación asincrónica.

(Heredado de IAsyncInfo)

Métodos

Cancel()

Cancela la operación asincrónica.

(Heredado de IAsyncInfo)
Close()

Cierra la operación asincrónica.

(Heredado de IAsyncInfo)
GetResults()

Devuelve los resultados de la acción.

Se aplica a

Consulte también