IAsyncOperation<TResult> インターフェイス

  • リファレンス

定義

名前空間:
Windows.Foundation
編集

完了時に結果を返す非同期操作を表します。 これは、結果を含むが進行状況を報告しない多くのWindows ランタイム非同期メソッドの戻り値の型です。

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

型パラメーター

TResult
派生
属性
ContractVersionAttribute GuidAttribute
実装
IAsyncInfo

Windows の要件

デバイス ファミリ
Windows 10 (10.0.10240.0 で導入)
API contract
Windows.Foundation.FoundationContract (v1.0 で導入)

注釈

IAsyncOperation<TResult> は、完了時に結果を得るが進行状況を報告しない多くのWindows ランタイム非同期メソッドの戻り値の型です。 これは、650 を超える異なるWindows ランタイム API を構成します。 進行状況を報告する (結果が得られた) API では、別のインターフェイス IAsyncOperationWithProgress<TResult,TProgress が使用されます>。

アプリ コードで IAsyncOperation<TResult> ( TResult 固有の制約を持つ) を返すメソッドを使用する場合、通常は IAsyncOperation の戻り値に直接アクセスしません。 これは、ほとんどの場合、言語固有の待機可能な構文を使用するためです。 この場合、メソッドの明らかな戻り値は 、TResult パラメーターとして指定された型です。 詳細については、「非同期プログラミング」を参照するか、非同期プログラミングをWindows ランタイムするための言語固有のガイド (C# または Visual Basic、C++、JavaScriptで非同期 API を呼び出す) を参照してください。

言語固有の待機可能な構文を使用しない場合でも、IAsyncOperation<TResult> を直接使用することは一般的ではありません。 各言語には、Windows ランタイム インターフェイスよりも一般的に使いやすい拡張ポイントがあります。 JavaScript には WinJS.Promise と then/done 構文があります。 .NET には AsTask 拡張メソッドがあり、IAsyncOperation<TResult> が タスク<TResult> に変換されると、結果の取得、取り消し、完了時の通知の取得などが簡単になります。 C++/CX の場合は、 コンカレンシー ランタイム を使用して呼び出しをラップできます ( また、create_taskを使用します)。 つまり、IAsyncOperation<TResult> はランタイム レベルのインフラストラクチャと見なすことができます。各言語は、待機可能な構文または非同期プログラミング モデルを独自の方法でサポートするためのフレームワークとして使用されます。

IAsyncOperation<TResult> を使用する代わりに、一部のWindows ランタイム非同期メソッドではカスタム操作の種類が使用されます。 たとえば、DataReaderLoadOperation は、結果の型として uint を使用して IAsyncOperation を実装するWindows ランタイム型です。 DataReaderLoadOperation 型は、DataReader.LoadAsync メソッドのカスタム操作/結果型として使用されます。

C++/WinRT 拡張機能関数

注意

拡張関数は、特定のWindows ランタイム API の C++/WinRT プロジェクション型に存在します。 たとえば、 winrt::Windows::Foundation::IAsyncAction は 、IAsyncAction の C++/WinRT プロジェクション型です。 拡張関数は、実際のWindows ランタイム型のアプリケーション バイナリ インターフェイス (ABI) サーフェスの一部ではないため、Windows ランタイム API のメンバーとして一覧表示されません。 ただし、任意の C++/WinRT プロジェクト内から呼び出すことができます。 API を拡張する C++/WinRT 関数Windows ランタイム参照してください。

TResult get() const;

操作が完了するまで同期的に待機し、完了した値を返します。 操作が取り消された場合、またはエラー状態になった場合は、対応する例外をスローします。 シングルスレッド アパートメントから呼び出すことはできません。 詳細と、 get を呼び出す方法を示すコード例については、「 コルーチンを記述する」を参照してください。

AsyncStatus wait_for(TimeSpan const& timeout) const;

操作が完了するか、指定されたタイムアウトまで同期的に待機します。 タイムアウトが経過した場合は 、IAsyncOperation または AsyncStatus::Started の状態を返します。 アクションがタイムアウトしなかった場合は、 GetResults を呼び出して操作の結果を取得します。 詳細と、 wait_forを呼び出す方法を示すコード例については、「 非同期タイムアウトが簡単になりました」を参照してください。

インターフェイスの継承

IAsyncOperation<TResult> は IAsyncInfo を継承します。 IAsyncOperation<TResult> を実装する型は、 IAsyncInfo のインターフェイス メンバーも実装します。

実装者へのメモ

既存のメソッドの呼び出しと同様に、IAsyncOperation<TResult> を直接使用しない非同期メソッドを定義する言語固有の方法があります。 .NET を使用してコードを記述する場合、メソッドは Task<TResult> を返すことができます。 C++/CX の場合は、 コンカレンシー ランタイムを使用できます。 ただし、コンポーネントを定義する場合は、タスク/タスクを内部的に使用できますが、パブリック メソッドのWindows ランタイム インターフェイスのいずれかを返す必要があります。 言語固有の非同期サポート型 (およびコードで従来使用されるその他の多くの言語固有の型) は、Windows ランタイム コンポーネントのパブリック サーフェス領域には使用できません。

プロパティ

Completed

操作の完了時に呼び出されるデリゲートを取得または設定します。
ErrorCode

非同期操作のエラー条件を表す文字列を取得します。

(継承元 IAsyncInfo)
Id

非同期操作のハンドルを取得します。

(継承元 IAsyncInfo)
Status

非同期操作の状態を示す値を取得します。

(継承元 IAsyncInfo)

メソッド

Cancel()

非同期操作を取り消します。

(継承元 IAsyncInfo)
Close()

非同期操作を閉じます。

(継承元 IAsyncInfo)
GetResults()

操作の結果を返します。

適用対象

こちらもご覧ください