Share via

  • Article

ScriptBuffer.EndOfRowset Method

Returns a value that indicates whether the end of the rows in a buffer has been reached.

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

Syntax

'Declaration
Protected Function EndOfRowset As Boolean
'Usage
Dim returnValue As Boolean

returnValue = Me.EndOfRowset()

protected bool EndOfRowset()

protected:
bool EndOfRowset()

member EndOfRowset : unit -> bool 

protected function EndOfRowset() : boolean

Return Value

Type: System.Boolean
true if the end of the rows in a buffer has been reached; 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.

The developer can use the EndOfRowset method after reading all input rows to determine whether the final input buffer has been received.

Examples

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

        If Buffer.EndOfRowset Then
            InputsFinished = InputsFinished + 1
            If InputsFinished = 1 Then
                FinishOutputs()
                MarkOutputsFinished()
            End If
        End If