Export (0) Print
Expand All

SqlPipe.SendResultsRow Method

Sends a single row of data back to the client.

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

public void SendResultsRow(
	SqlDataRecord record
)

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.

ExceptionCondition
ArgumentNullException

The record is null.

InvalidOperationException

The SendResultsStart method was not previously called.

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.

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

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft