DataflowBlock::LinkTo<TOutput> Method (ISourceBlock<TOutput>^, ITargetBlock<TOutput>^, DataflowLinkOptions^, Predicate<TOutput>^)

 

Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter.

Namespace:   System.Threading.Tasks.Dataflow
Assembly:  System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)

public:
generic<typename TOutput>
[ExtensionAttribute]
static IDisposable^ LinkTo(
	ISourceBlock<TOutput>^ source,
	ITargetBlock<TOutput>^ target,
	DataflowLinkOptions^ linkOptions,
	Predicate<TOutput>^ predicate
)

Parameters

source
Type: System.Threading.Tasks.Dataflow::ISourceBlock<TOutput>^

The source from which to link.

target
Type: System.Threading.Tasks.Dataflow::ITargetBlock<TOutput>^

The ITargetBlock<TInput> to which to connect the source.

linkOptions
Type: System.Threading.Tasks.Dataflow::DataflowLinkOptions^

One of the enumeration values that specifies how to configure a link between dataflow blocks.

predicate
Type: System::Predicate<TOutput>^

The filter a message must pass in order for it to propagate from the source to the target.

Return Value

Type: System::IDisposable^

An IDisposable that, upon calling Dispose, will unlink the source from the target.

Type Parameters

TOutput

Specifies the type of data contained in the source.

Exception Condition
ArgumentNullException

The source is null (Nothing in Visual Basic).

-or-

The target is null (Nothing in Visual Basic).

-or-

The linkOptions is null (Nothing in Visual Basic).

-or-

The predicate is null (Nothing in Visual Basic).

Return to top
Show: