This documentation is archived and is not being maintained.

SqlPipe Class

Allows managed stored procedures running in-process on a SQL Server database to return results back to the caller. This class cannot be inherited.


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

public sealed class SqlPipe

The SqlPipe type exposes the following members.

Public propertyIsSendingResultsGets a value that indicates whether the SqlPipe is in the mode of sending single result sets back to the client. This property is read-only.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExecuteAndSendExecutes the command passed as a parameter and sends the results to the client.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSend(SqlDataReader)Sends a multirow result set directly to the client or current output consumer.
Public methodSend(SqlDataRecord)Sends a single-row result set directly to the client or current output consumer.
Public methodSend(String)Sends a string message directly to the client or current output consumer.
Public methodSendResultsEndMarks the end of a result set, and returns the SqlPipe instance back to the initial state.
Public methodSendResultsRowSends a single row of data back to the client.
Public methodSendResultsStartMarks 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 methodToStringReturns a string that represents the current object. (Inherited from Object.)

An instance of this class is made available to managed stored procedures through the Pipe property of the SqlContext class.

The following example uses SqlConnection and SqlCommand to select rows from a data source in a stored procedure. The example then uses a SqlPipe to execute the command and send the results back to the client.

	public static void StoredProcExecuteCommand(int rating)
		// Connect through the context connection.
		using (SqlConnection connection = new SqlConnection("context connection=true"))

			SqlCommand command = new SqlCommand(
				"SELECT VendorID, AccountNumber, Name FROM Purchasing.Vendor " +
				"WHERE CreditRating <= @rating", connection);
			command.Parameters.AddWithValue("@rating", rating);

			// Execute the command and send the results directly to the client.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.