SqlPipe.SendResultsRow Method (Microsoft.SqlServer.Server)

.NET Framework Class Library

SqlPipe..::.SendResultsRow Method

Sends a single row of data back to the client.

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

Syntax

Visual Basic (Declaration)

Public Sub SendResultsRow ( _
    record As SqlDataRecord _
)

Visual Basic (Usage)

Dim instance As SqlPipe
Dim record As SqlDataRecord

instance.SendResultsRow(record)

public void SendResultsRow(
    SqlDataRecord record
)

Visual C++

public:
void SendResultsRow(
    SqlDataRecord^ record
)

JScript

public function SendResultsRow(
    record : SqlDataRecord
)

Parameters

record: Type: Microsoft.SqlServer.Server..::.SqlDataRecord
A SqlDataRecord object with the column values for the row to be sent to the client. The schema for the record must match the schema described by the metadata of the SqlDataRecord passed to the SendResultsStart method.

Exceptions

Exception	Condition
ArgumentNullException	The record is nullNothingnullptra null reference (Nothing in Visual Basic).
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 SendResultsEnd, allows stored procedures to send custom result sets to the client.

The SendResultsRow method sends a single row of data back to the client. Rows can subsequently be returned to the caller by calling SendResultsRow, one time for each row being sent. After all the rows have been sent, a call to the SendResultsEnd method is required to mark the end of the result set.

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

    [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

Reference

SqlPipe Class

SqlPipe Members

Microsoft.SqlServer.Server Namespace

SendResultsStart

SendResultsEnd