IAsyncAction Interface

  • Referência

Definição

Namespace:
Windows.Foundation
Editar

Representa uma ação assíncrona. Esse é o tipo de retorno para muitos Windows Runtime métodos assíncronos que não têm um objeto de resultado e não relatam o progresso contínuo.

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
Implementações
IAsyncInfo

Requisitos do Windows

Família de dispositivos
Windows 10 (introduzida na 10.0.10240.0)
API contract
Windows.Foundation.FoundationContract (introduzida na v1.0)

Comentários

IAsyncAction é o tipo de retorno para todos os métodos assíncronos Windows Runtime que não comunicam um objeto de resultado ou progresso contínuo. Isso constitui mais de 300 APIs de Windows Runtime diferentes. As APIs que relatam o progresso (mas não têm um resultado) usam outra interface, IAsyncActionWithProgress<TProgress>.

Quando você usa métodos que retornam IAsyncAction no código do aplicativo, geralmente não acessa o valor retornado de IAsyncAction diretamente. Isso ocorre porque você quase sempre usa a sintaxe awaitable específica da linguagem. Nesse caso, o valor retornado aparente do método é nulo. Para obter mais informações, consulte Programação assíncrona ou um dos guias específicos da linguagem para Windows Runtime programação assíncrona (chamar APIs assíncronas em C# ou Visual Basic, C++, JavaScript).

IAsyncAction também é um tipo de entrada para algumas APIs de utilitário de cenário avançado, como CoreDispatcher.RunAsync e ThreadPool.RunAsync.

Não é comum usar IAsyncAction diretamente, mesmo que você não use uma sintaxe aguardável específica da linguagem. Cada um dos idiomas tem pontos de extensão que geralmente são mais fáceis de usar do que a interface Windows Runtime. O JavaScript tem WinJS.Promise e a sintaxe then/done . O .NET tem o método de extensão AsTask e, depois que o IAsyncAction é convertido em uma Tarefa, é mais fácil cancelar, receber notificação após a conclusão e assim por diante. Para C++/CX, você pode encapsular as chamadas usando o runtime de simultaneidade (e usar create_task). Em outras palavras, IAsyncAction pode ser considerada infraestrutura em nível de runtime, que cada uma das linguagens usa como uma estrutura para dar suporte a modelos de programação assíncrona ou sintaxe aguardável à sua maneira.

Em vez de usar IAsyncAction, alguns Windows Runtime métodos assíncronos usam tipos de ação personalizados (que podem ter "Operação" em vez de "Ação" em seu nome). Por exemplo, SignOutUserOperation é um tipo Windows Runtime que implementa IAsyncAction. O tipo SignOutUserOperation é usado como o tipo de retorno de ação personalizada para o método SignOutUserAsync .

Funções de extensão C++/WinRT

Observação

Existem funções de extensão nos tipos de projeção C++/WinRT para determinadas APIs de Windows Runtime. Por exemplo, winrt::Windows::Foundation::IAsyncAction é o tipo de projeção C++/WinRT para IAsyncAction. As funções de extensão não fazem parte da superfície da ABI (interface binária do aplicativo) dos tipos de Windows Runtime reais, portanto, elas não são listadas como membros das APIs de Windows Runtime. Mas você pode chamá-los de dentro de qualquer projeto C++/WinRT. Consulte Funções C++/WinRT que estendem apIs de Windows Runtime.

void get() const;

Aguarda de forma síncrona a conclusão da ação. Gera uma exceção correspondente se a ação é cancelada ou insere um estado de erro. Você não deve chamá-lo de um apartamento de thread único. Para obter mais informações e exemplos de código mostrando como chamar get, consulte Gravar uma corrotina.

AsyncStatus wait_for(TimeSpan const& timeout) const;

Aguarda de forma síncrona a conclusão da ação ou o tempo limite especificado. Retorna o estado de IAsyncAction ou AsyncStatus::Started se o tempo limite tiver decorrido. Se a ação não atingiu o tempo limite, chame GetResults para obter os resultados da ação. Para obter mais informações e exemplos de código mostrando como chamar wait_for, consulte Tempos limite assíncronos facilitado.

Herança de interface

IAsyncAction herda IAsyncInfo. Os tipos que implementam o IAsyncAction também implementam os membros da interface IAsyncInfo:

Anotações aos implementadores

Assim como na chamada dos métodos existentes, há maneiras específicas de definir métodos assíncronos que não usam IAsyncInfo diretamente. Se estiver escrevendo código usando o .NET, seu método poderá retornar uma Tarefa. Para C++/CX, você pode usar o runtime de simultaneidade. No entanto, se você estiver definindo um componente, poderá usar atarefaTarefa/ internamente, mas deverá retornar uma das interfaces Windows Runtime para seus métodos públicos. Os tipos de suporte assíncronos específicos da linguagem (e muitos outros tipos específicos de linguagem que você pode usar convencionalmente no código) não podem ser usados para a área de superfície pública de um componente Windows Runtime.

Propriedades

Completed

Obtém ou define o delegado que é chamado quando a ação é concluída.
ErrorCode

Obtém uma cadeia de caracteres que descreve uma condição de erro da operação assíncrona.

(Herdado de IAsyncInfo)
Id

Obtém o identificador da operação assíncrona.

(Herdado de IAsyncInfo)
Status

Obtém um valor que indica o status da operação assíncrona.

(Herdado de IAsyncInfo)

Métodos

Cancel()

Cancela a operação assíncrona.

(Herdado de IAsyncInfo)
Close()

Fecha a operação assíncrona.

(Herdado de IAsyncInfo)
GetResults()

Retorna os resultados da ação.

Aplica-se a

Confira também