ScriptComponent.ProcessInput Method

Article
12/03/2008

Processes the inputs in Script components, such as transformations and destinations, that receive inputs from upstream components.

Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.TxScript (in microsoft.sqlserver.txscript.dll)

Syntax

'Declaration
Public Overridable Sub ProcessInput ( _
    InputID As Integer, _
    Buffer As PipelineBuffer _
)

public virtual void ProcessInput (
    int InputID,
    PipelineBuffer Buffer
)

public:
virtual void ProcessInput (
    int InputID, 
    PipelineBuffer^ Buffer
)

public void ProcessInput (
    int InputID, 
    PipelineBuffer Buffer
)

public function ProcessInput (
    InputID : int, 
    Buffer : PipelineBuffer
)

Parameters

InputID
The ID of the input to process.

Buffer
A PipelineBuffer that contains the input rows.

Remarks

The Script component developer does not use the ScriptComponent class directly, but indirectly, by coding the methods and properties of the ScriptMain class, which inherits from ScriptComponent through the UserComponent class.

Although the developer can override the ProcessInput method, it is usually sufficient to override the <InputBufferX>_ProcessInputRows method in the ScriptMain class to process data from the input buffers. When additional processing is required, it may be preferable to override the <InputBufferX>_ProcessInput method.

Example

The following code sample from the autogenerated ComponentWrapper project item shows how the Script component uses the ProcessInput method.

    Public Overridable Sub Input0_ProcessInput(ByVal Buffer As Input0Buffer)

        While Buffer.NextRow()
            Input0_ProcessInputRow(Buffer)
        End While

    End Sub

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms