SqlPipe.SendResultsStart(SqlDataRecord) Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Server
Assembly:
System.Data.dll

Marks the beginning of a result set to be sent back to the client, and uses the record parameter to construct the metadata that describes the result set.

public:
 void SendResultsStart(Microsoft::SqlServer::Server::SqlDataRecord ^ record);
public void SendResultsStart (Microsoft.SqlServer.Server.SqlDataRecord record);
member this.SendResultsStart : Microsoft.SqlServer.Server.SqlDataRecord -> unit
Public Sub SendResultsStart (record As SqlDataRecord)

Parameters

record
SqlDataRecord

A SqlDataRecord object from which metadata is extracted and used to describe the result set.

Exceptions

ArgumentNullException

The record is null.

ArgumentException

The record has no columns or has not been initialized.

InvalidOperationException

A method other than SendResultsRow(SqlDataRecord) or SendResultsEnd() was called after the SendResultsStart(SqlDataRecord) method.

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.

[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();
}

<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

Remarks

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

The SendResultsStart method marks the beginning of a result set, and uses the record parameter to construct the metadata that describes the result set. All the subsequent rows, sent using the SendResultsRow method, must match that metadata definition.

Note that after calling SendResultsStart, only SendResultsRow and SendResultsEnd can be called. Any other method in the same instance of SqlPipe throws an InvalidOperationException. SendResultsEnd sets SqlPipe back to the initial state where other methods can be called.

After control returns to Transact-SQL from CLR execution, do not attempt to use a static or local variable initialized to CLR memory. For example, do not store an instance of an in process class, for example SQLDataRecord, which will be used after control returns from CLR. One exception is the SQLMetaData in process class.

Applies to

See also