.NET Framework Class Library
SqlPipe..::.SendResultsEnd Method

Marks the end of a result set, and returns the SqlPipe instance back to the initial state.

Namespace:  Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)
Syntax

Visual Basic (Declaration)
Public Sub SendResultsEnd
Visual Basic (Usage)
Dim instance As SqlPipe

instance.SendResultsEnd()
C#
public void SendResultsEnd()
Visual C++
public:
void SendResultsEnd()
JScript
public function SendResultsEnd()
Exceptions

ExceptionCondition
InvalidOperationException

The SendResultsStart method was not previously called.

Remarks

Managed stored procedures can send result sets to clients that are not implementing a SqlDataReader. This method, along with SendResultsStart and SendResultsRow, allow stored procedures to send custom result sets to the client.

Examples

The following example creates a new SqlDataRecord and its SqlMetaData. The example then marks the beginning of a result set using the SendResultsStart method, sends records with example data back to the client using the SendResultsRow method, and marks the end of the result set with the SendResultsEnd method.

Visual Basic
<Microsoft.SqlServer.Server.SqlProcedure()> _
Public Shared Sub StoredProcReturnResultSet()

    ' Create the record and specify the metadata for the columns.
    Dim record As New SqlDataRecord( _
        New SqlMetaData("col1", SqlDbType.NVarChar, 100), _
        New SqlMetaData("col2", SqlDbType.Int))

    ' Mark the begining of the result-set.
    SqlContext.Pipe.SendResultsStart(record)

    ' Send 10 rows back to the client.
    Dim i As Integer
    For i = 0 To 9

        ' Set values for each column in the row.
        record.SetString(0, "row " & i.ToString())
        record.SetInt32(1, i)

        ' Send the row back to the client.
        SqlContext.Pipe.SendResultsRow(record)
    Next

    ' Mark the end of the result-set.
    SqlContext.Pipe.SendResultsEnd()
End Sub
C#
    [Microsoft.SqlServer.Server.SqlProcedure]
    public static void StoredProcReturnResultSet()
    {
        // Create the record and specify the metadata for the columns.
        SqlDataRecord record = new SqlDataRecord(
            new SqlMetaData("col1", SqlDbType.NVarChar, 100),
            new SqlMetaData("col2", SqlDbType.Int));

        // Mark the begining of the result-set.
        SqlContext.Pipe.SendResultsStart(record);

        // Send 10 rows back to the client.
        for (int i = 0; i < 10; i++)
        {
            // Set values for each column in the row.
            record.SetString(0, "row " + i.ToString());
            record.SetInt32(1, i);

            // Send the row back to the client.
            SqlContext.Pipe.SendResultsRow(record);
        }

        // Mark the end of the result-set.
        SqlContext.Pipe.SendResultsEnd();
    }
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker