DataflowBlock.LinkTo(Of TOutput) Method (ISourceBlock(Of TOutput), ITargetBlock(Of TOutput), DataflowLinkOptions, Predicate(Of TOutput))

.NET Framework (current version)

Links the ISourceBlock(Of TOutput) to the specified ITargetBlock(Of TInput) using the specified filter.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function LinkTo(Of TOutput) ( _
	source As ISourceBlock(Of TOutput), _
	target As ITargetBlock(Of TOutput), _
	linkOptions As DataflowLinkOptions, _
	predicate As Predicate(Of TOutput) _
) As IDisposable

Type Parameters

TOutput

Specifies the type of data contained in the source.

Parameters

source
Type: System.Threading.Tasks.Dataflow.ISourceBlock(Of TOutput)

The source from which to link.

target
Type: System.Threading.Tasks.Dataflow.ITargetBlock(Of TOutput)

The ITargetBlock(Of 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(Of 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.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ISourceBlock(Of TOutput). 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).

ExceptionCondition
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).

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library
Show: