Export (0) Print
Expand All

ScriptBuffer Class

Serves as the base class for the read-only classes representing the input and the outputs that are generated by the Script component in the BufferWrapper project item in a Script component project.

System.Object
  Microsoft.SqlServer.Dts.Pipeline.ScriptBuffer

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

public class ScriptBuffer

The ScriptBuffer type exposes the following members.

  NameDescription
Public methodScriptBufferInitializes a new instance of the ScriptBuffer class.
Top

  NameDescription
Protected propertyItemGets or sets the value of a column in the buffer by using its index in the array of buffer column indexes.
Top

  NameDescription
Protected methodAddRowAdds an empty new row to the data flow buffer.
Protected methodDirectRowDirects a row to the specified output when a component has more than one available output.
Protected methodEndOfRowsetReturns a value that indicates whether the end of the rows in a buffer has been reached.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodIsNullReturns a value that indicates whether the value of the specified column is null.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNextRowTries to move to the next available row in the buffer and returns a value that indicates whether another row was available.
Protected methodSetEndOfRowsetIndicates to the data flow that no more rows will be added to the output buffer.
Protected methodSetNullMakes the value of the specified column null.
Public methodToString (Inherited from Object.)
Top

  NameDescription
Protected fieldBuffer
Protected fieldBufferColumnIndexesAn array of column indexes.
Top

The ScriptBuffer class serves as the base class for the read-only classes representing the input and the outputs that are generated by the Script component in the BufferWrapper project item in a Script component project. The classes in the BufferWrapper project item provide the developer with a set of methods for working with the data flow buffers, as well as typed accessor properties for each column in the buffers.

The Script component developer does not use the ScriptBuffer class directly, but indirectly, through the derived classes in the BufferWrapper project item that represent the component's input and outputs.

For more information, see Coding and Debugging the Script Component and Understanding the Script Component Object Model.

The following code sample from Creating an Asynchronous Transformation with the Script Component demonstrates several methods and properties of the ScriptBuffer class, including AddRow, NextRow, EndOfRowset, and SetEndOfRowset.

Public Class ScriptMain
    Inherits UserComponent

    Private myRedmondAddressCount As Integer

    Public Overrides Sub CreateNewOutputRows()

        MySummaryOutputBuffer.AddRow()

    End Sub

    Public Overrides Sub MyAddressInput_ProcessInput(ByVal Buffer As MyAddressInputBuffer)

        While Buffer.NextRow()
            MyAddressInput_ProcessInputRow(Buffer)
        End While

        If Buffer.EndOfRowset Then
            MyAddressOutputBuffer.SetEndOfRowset()
            MySummaryOutputBuffer.MyRedmondCount = myRedmondAddressCount
            MySummaryOutputBuffer.SetEndOfRowset()
        End If

    End Sub

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        With MyAddressOutputBuffer
            .AddRow()
            .AddressID = Row.AddressID
            .City = Row.City
        End With

        If Row.City.ToUpper = "REDMOND" Then
            myRedmondAddressCount += 1
        End If

    End Sub

End Class

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

Community Additions

ADD
Show:
© 2014 Microsoft