IDataflowBlock.Fault(Exception) Method

Reference

Definition

Namespace:: System.Threading.Tasks.Dataflow

Assembly:: System.Threading.Tasks.Dataflow.dll

Package:: System.Threading.Tasks.Dataflow v10.0.0-preview.1.25080.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Causes the IDataflowBlock to complete in a Faulted state.

public:
 void Fault(Exception ^ exception);

public void Fault(Exception exception);

abstract member Fault : Exception -> unit

Public Sub Fault (exception As Exception)

Parameters

exception: Exception

The Exception that caused the faulting.

Exceptions

ArgumentNullException

The exception is null.

Remarks

After Fault has been called on a dataflow block, that block will complete, and its Completion task will enter a final state. Faulting a block, as with canceling a block, causes buffered messages (unprocessed input messages as well as unoffered output messages) to be lost.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10
.NET Standard	2.0 (package-provided), 2.1 (package-provided)
UWP	10.0

Share via