WriteOnceBlock<T>.IDataflowBlock.Fault(Exception) Method

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Source:

WriteOnceBlock.cs

Causes the IDataflowBlock to complete in a Faulted state.

 virtual void System.Threading.Tasks.Dataflow.IDataflowBlock.Fault(Exception ^ exception) = System::Threading::Tasks::Dataflow::IDataflowBlock::Fault;

void IDataflowBlock.Fault (Exception exception);

abstract member System.Threading.Tasks.Dataflow.IDataflowBlock.Fault : Exception -> unit
override this.System.Threading.Tasks.Dataflow.IDataflowBlock.Fault : Exception -> unit

Sub Fault (exception As Exception) Implements IDataflowBlock.Fault

Parameters

exception

Exception

The Exception that caused the faulting.

Implements

Fault(Exception)

Exceptions

ArgumentNullException

The exception is null.

Remarks

After IDataflowBlock.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.