SqlPipe Class

.NET Framework (current version)

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)

Inheritance Hierarchy

System::Object
Microsoft.SqlServer.Server::SqlPipe

Syntax

C++

public ref class SqlPipe sealed

Properties

	Name	Description
	IsSendingResults	Gets 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.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	ExecuteAndSend(SqlCommand^)	Executes the command passed as a parameter and sends the results to the client.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Send(SqlDataReader^)	Sends a multirow result set directly to the client or current output consumer.
	Send(SqlDataRecord^)	Sends a single-row result set directly to the client or current output consumer.
	Send(String^)	Sends a string message directly to the client or current output consumer.
	SendResultsEnd()	Marks the end of a result set, and returns the SqlPipe instance back to the initial state.
	SendResultsRow(SqlDataRecord^)	Sends a single row of data back to the client.
	SendResultsStart(SqlDataRecord^)	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.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

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.

C++

No code example is currently available or this language may not be supported.