IAsyncOperation<TResult> Interface

  • Referência

Definição

Namespace:
Windows.Foundation
Editar

Representa uma operação assíncrona, que retorna um resultado após a conclusão. Esse é o tipo de retorno para muitos Windows Runtime métodos assíncronos que têm resultados, mas não relatam progresso.

public interface class IAsyncOperation : IAsyncInfo
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.FoundationContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(2680336571, 58438, 17634, 170, 97, 156, 171, 143, 99, 106, 242)]
template <typename TResult>
struct IAsyncOperation : IAsyncInfo
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.FoundationContract), 65536)]
[Windows.Foundation.Metadata.Guid(2680336571, 58438, 17634, 170, 97, 156, 171, 143, 99, 106, 242)]
public interface IAsyncOperation<TResult> : IAsyncInfo
Public Interface IAsyncOperation(Of TResult)
Implements IAsyncInfo

Parâmetros de tipo

TResult
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

IAsyncOperation<TResult> é o tipo de retorno para muitos Windows Runtime métodos assíncronos que têm um resultado após a conclusão, mas não relatam o progresso. Isso constitui mais de 650 APIs de Windows Runtime diferentes. As APIs que relatam o progresso (e têm um resultado) usam outra interface, IAsyncOperationWithProgress<TResult,TProgress>.

Quando você usa métodos que retornam IAsyncOperation<TResult> (com uma restrição específica de TResult ) no código do aplicativo, você geralmente não acessa o valor retornado de IAsyncOperation diretamente. Isso ocorre porque você quase sempre usa a sintaxe awaitable específica da linguagem. Nesse caso, o valor retornado aparente do método é o tipo fornecido como o parâmetro TResult . 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).

Não é comum usar IAsyncOperation<TResult> diretamente, mesmo que você não use uma sintaxe aguardável específica do idioma. 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 IAsyncOperation<TResult> é convertido em um TResult> de Tarefa<, é mais fácil obter o resultado, cancelar, receber notificação sobre 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, o IAsyncOperation<TResult> pode ser considerado uma infraestrutura de 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 o IAsyncOperation<TResult>, alguns Windows Runtime métodos assíncronos usam tipos de operação personalizados. Por exemplo, DataReaderLoadOperation é um tipo Windows Runtime que implementa IAsyncOperation usando uint como o tipo de resultado. O tipo DataReaderLoadOperation é usado como o tipo de operação/resultado personalizado para o método DataReader.LoadAsync .

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.

TResult get() const;

Aguarda de forma síncrona a conclusão da operação e retorna o valor concluído. Gera uma exceção correspondente se a operaçã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 operação ou o tempo limite especificado. Retorna o estado de IAsyncOperation 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 operaçã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

IAsyncOperation<TResult> herda IAsyncInfo. Os tipos que implementam o IAsyncOperation<TResult> também implementam os membros da interface do IAsyncInfo:

Anotações aos implementadores

Assim como ao chamar os métodos existentes, há maneiras específicas de definir métodos assíncronos que não usam IAsyncOperation<TResult> diretamente. Se estiver escrevendo código usando .NET, seu método poderá retornar um TResult> de 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 operaçã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 operação.

Aplica-se a

Confira também