Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
SqlPipe Class
SqlPipe Methods
 SendResultsStart Method

  Switch on low bandwidth view
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
SqlPipe..::.SendResultsStart Method

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.

Namespace:  Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)
Visual Basic (Declaration)
Public Sub SendResultsStart ( _
    record As SqlDataRecord _
)
Visual Basic (Usage)
Dim instance As SqlPipe
Dim record As SqlDataRecord

instance.SendResultsStart(record)
C#
public void SendResultsStart(
    SqlDataRecord record
)
Visual C++
public:
void SendResultsStart(
    SqlDataRecord^ record
)
JScript
public function SendResultsStart(
    record : SqlDataRecord
)

Parameters

record
Type: Microsoft.SqlServer.Server..::.SqlDataRecord
A SqlDataRecord object from which metadata is extracted and used to describe the result set.
ExceptionCondition
ArgumentNullException

The record is nullNothingnullptra null reference (Nothing in Visual Basic).

ArgumentException

The record has no columns or has not been initialized.

InvalidOperationException

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

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.

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

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker