TaskCompletionSourceExtensions.SetFromTask(TResult) Method (TaskCompletionSource(TResult), Task, TResult)

TaskCompletionSourceExtensionsSetFromTaskTResult Method (TaskCompletionSourceTResult, Task, TResult)

Transfers the result of a TaskTResult to a TaskCompletionSourceTResult, using a specified result value when the task is in the RanToCompletion state.

Namespace: Rackspace.Threading
Assembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 2.1.0-beta1

Syntax

C++

Copy

public static void SetFromTask<TResult>(
	this TaskCompletionSource<TResult> taskCompletionSource,
	Task task,
	TResult result
)

<ExtensionAttribute>
Public Shared Sub SetFromTask(Of TResult) ( 
	taskCompletionSource As TaskCompletionSource(Of TResult),
	task As Task,
	result As TResult
)

public:
[ExtensionAttribute]
generic<typename TResult>
static void SetFromTask(
	TaskCompletionSource<TResult>^ taskCompletionSource, 
	Task^ task, 
	TResult result
)

[<ExtensionAttribute>]
static member SetFromTask : 
        taskCompletionSource : TaskCompletionSource<'TResult> * 
        task : Task * 
        result : 'TResult -> unit

Parameters

taskCompletionSource: Type: System.Threading.TasksTaskCompletionSourceTResult
The TaskCompletionSourceTResult instance.
task: Type: System.Threading.TasksTask
The result task whose completion results should be transferred.
result: Type: TResult
The result of the completion source when the specified task completed successfully.

Type Parameters

TResult: Specifies the result type of the TaskCompletionSourceTResult.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type TaskCompletionSourceTResult. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	If taskCompletionSource is . -or- If task is .
ObjectDisposedException	If the underlying TaskTResult of taskCompletionSource was disposed.
InvalidOperationException	If the underlying TaskTResult produced by taskCompletionSource is already in one of the three final states: RanToCompletion, Faulted, or Canceled.

Exception

Condition

ArgumentNullException

If taskCompletionSource is .

-or-

If task is .

ObjectDisposedException

If the underlying TaskTResult of taskCompletionSource was disposed.

InvalidOperationException

If the underlying TaskTResult produced by taskCompletionSource is already in one of the three final states: RanToCompletion, Faulted, or Canceled.

Remarks

If task is in the RanToCompletion state, the specified result value is assigned to the TaskCompletionSourceTResult using the SetResult(TResult) method.

If task is in the Faulted state, the unwrapped exceptions are bound to the TaskCompletionSourceTResult using the SetException(IEnumerableException) method.

If task is in the Canceled state, the TaskCompletionSourceTResult is transitioned to the Canceled state using the SetCanceled method.

Version Information

.NET for Windows Store apps

Supported in: Windows 8

.NET Framework

Supported in: 4.5, 4.0, 3.5

Portable Class Library

Supported in: Portable Class Library (Legacy), Portable Class Library

Threading Library

Supported in: 2.1, 2.0, 1.1

Reference

TaskCompletionSourceExtensions Class

SetFromTask Overload

Rackspace.Threading Namespace