SqlPipe.SendResultsRow Method (SqlDataRecord)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

Exception Condition
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
Available since 2.0
Return to top
Show: