ScriptBuffer.NextRow Method

Article
12/03/2008

Tries to move to the next available row in the buffer and returns a value that indicates whether another row was available.

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

Syntax

'Declaration
Protected Function NextRow As Boolean

protected bool NextRow ()

protected:
bool NextRow ()

protected boolean NextRow ()

protected function NextRow () : boolean

Return Value

true if another row was available and has become the current row; otherwise, false.

Remarks

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.

If you use only the <InputBufferX>_ProcessInputRow method to loop through rows, then the NextRow method is called for you by the <InputBufferX>_ProcessInput method.

Example

The following sample code from the autogenerated ComponentWrapper project item demonstrates how the Script component uses the NextRow 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