PipelineComponent.PrimeOutput Method

Called at run time for source components and transformation components with asynchronous outputs to let these components add rows to the output buffers.

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

'Declaration
Public Overridable Sub PrimeOutput ( _
    outputs As Integer, _
    outputIDs As Integer(), _
    buffers As PipelineBuffer() _
)
'Usage
Dim instance As PipelineComponent
Dim outputs As Integer
Dim outputIDs As Integer()
Dim buffers As PipelineBuffer()

instance.PrimeOutput(outputs, outputIDs, _
    buffers)
public virtual void PrimeOutput(
    int outputs,
    int[] outputIDs,
    PipelineBuffer[] buffers
)
public:
virtual void PrimeOutput(
    int outputs, 
    array<int>^ outputIDs, 
    array<PipelineBuffer^>^ buffers
)
abstract PrimeOutput : 
        outputs:int * 
        outputIDs:int[] * 
        buffers:PipelineBuffer[] -> unit 
override PrimeOutput : 
        outputs:int * 
        outputIDs:int[] * 
        buffers:PipelineBuffer[] -> unit 
public function PrimeOutput(
    outputs : int, 
    outputIDs : int[], 
    buffers : PipelineBuffer[]
)

Parameters

  • outputs
    Type: System.Int32
    The number of elements in the outputIDs and buffers arrays.

Remarks

The number of elements in the outputIDs and buffers array is determined by the number of IDTSOutput100 objects in the IDTSOutputCollection100 collection of the component connected to an IDTSPath100 object.

Each element in the outputIDs array has a PipelineBuffer at the same index in the buffers array.

Rows are added to the PipelineBuffer by calling the AddRow method, and when finished, the SetEndOfRowset method is called to notify the data flow task that the component is finished adding rows. The SetEndOfRowset method sets the value of the EndOfRowset property to true on the final buffer.

PrimeOutput is called for components whose SynchronousInputID property is set to zero.