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.
Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.TxScript (in Microsoft.SqlServer.TxScript.dll)
The ScriptBuffer type exposes the following members.
.gif?cs-save-lang=1&cs-lang=cpp "Protected property")
| Name | Description | |
|---|---|---|
.gif?cs-save-lang=1&cs-lang=cpp "Protected method") | AddRow | Adds an empty new row to the data flow buffer. |
| DirectRow | Directs a row to the specified output when a component has more than one available output. |
| EndOfRowset | Returns a value that indicates whether the end of the rows in a buffer has been reached. |
.gif?cs-save-lang=1&cs-lang=cpp "Public method") | Equals | (Inherited from Object.) |
| Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| IsNull | Returns a value that indicates whether the value of the specified column is nullptr. |
| MemberwiseClone | (Inherited from Object.) |
| NextRow | Tries to move to the next available row in the buffer and returns a value that indicates whether another row was available. |
| SetEndOfRowset | Indicates to the data flow that no more rows will be added to the output buffer. |
| SetNull | Makes the value of the specified column nullptr. |
| ToString | (Inherited from Object.) |
.gif?cs-save-lang=1&cs-lang=cpp "Protected field")
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
