Task.FromException メソッド

定義

名前空間:

System.Threading.Tasks

アセンブリ:

netstandard.dll, System.Runtime.dll

オーバーロード

FromException(Exception)	指定した例外で完了した Task を作成します。
FromException<TResult>(Exception)	指定した例外で完了した Task<TResult> を作成します。

FromException(Exception)

ソース:

Task.cs

指定した例外で完了した Task を作成します。

public static System.Threading.Tasks.Task FromException(Exception exception);

パラメーター

exception

Exception

タスクを完了させる例外。

戻り値

Task

エラーが発生したタスク。

注釈

このメソッドは、 プロパティが Task で、そのプロパティに ExceptionStatusFaulted が含まれる オブジェクトを作成します。exception メソッドは、タスクが実行する作業によって、長いコード パスを実行する前に例外がスローされることがわかっている場合に一般的に使用されます。 例については、 オーバーロードに関するページを FromException<TResult>(Exception) 参照してください。

FromException<TResult>(Exception)

ソース:

Task.cs

指定した例外で完了した Task<TResult> を作成します。

public static System.Threading.Tasks.Task<TResult> FromException<TResult>(Exception exception);

型パラメーター

TResult

タスクによって返される結果の型。

パラメーター

exception

Exception

タスクを完了させる例外。

戻り値

Task<TResult>

エラーが発生したタスク。

例

次の例は、コマンド ライン 引数として名前が渡される各ディレクトリ内のファイル内のバイト数を計算するコマンド ライン ユーティリティです。 この例では、オブジェクトをインスタンス化 FileInfo し、ディレクトリ内の各ファイルのプロパティの値を FileInfo.Length 取得する長いコード パスを実行するのではなく、 メソッドを呼び出 FromException<TResult>(Exception) して、特定のサブディレクトリが存在しない場合にエラーが発生したタスクを作成します。

using System;
using System.Collections.Generic;
using System.IO;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      string[] args = Environment.GetCommandLineArgs();
      if (args.Length > 1) {
         List<Task<long>> tasks = new List<Task<long>>();
         for (int ctr = 1; ctr < args.Length; ctr++)
            tasks.Add(GetFileLengthsAsync(args[ctr]));

         try {
            Task.WaitAll(tasks.ToArray());
         }
         // Ignore exceptions here.
         catch (AggregateException) {}

         for (int ctr = 0 ; ctr < tasks.Count; ctr++) {
            if (tasks[ctr].Status == TaskStatus.Faulted)
               Console.WriteLine("{0} does not exist", args[ctr + 1]);
            else
               Console.WriteLine("{0:N0} bytes in files in '{1}'",
                                 tasks[ctr].Result, args[ctr + 1]);
         }
      }
      else {
         Console.WriteLine("Syntax error: Include one or more file paths.");
      }
   }

   private static Task<long> GetFileLengthsAsync(string filePath)
   {
      if (!Directory.Exists(filePath)) {
         return Task.FromException<long>(
                     new DirectoryNotFoundException("Invalid directory name."));
      }
      else {
         string[] files = Directory.GetFiles(filePath);
         if (files.Length == 0)
            return Task.FromResult(0L);
         else
            return Task.Run( () => { long total = 0;
                                     Parallel.ForEach(files, (fileName) => {
                                                 var fs = new FileStream(fileName, FileMode.Open,
                                                                         FileAccess.Read, FileShare.ReadWrite,
                                                                         256, true);
                                                 long length = fs.Length;
                                                 Interlocked.Add(ref total, length);
                                                 fs.Close(); } );
                                     return total;
                                   } );
      }
   }
}
// When launched with the following command line arguments:
//      subdir . newsubdir
// the example displays output like the following:
//       0 bytes in files in 'subdir'
//       2,059 bytes in files in '.'
//       newsubdir does not exist

注釈

このメソッドは、 プロパティが Task<TResult> で、そのプロパティに ExceptionStatusFaulted が含まれる オブジェクトを作成します。exception メソッドは、タスクが実行する作業によって、長いコード パスを実行する前に例外がスローされることがわかっている場合に一般的に使用されます。 具体的な例を次に示します。