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)
The SqlPipe type exposes the following members.
| 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. |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteAndSend | Executes the command passed as a parameter and sends the results to the client. |
| GetHashCode | Serves as a hash function for a particular type. (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 | Sends a single row of data back to the client. |
| SendResultsStart | 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.) |
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.
[Microsoft.SqlServer.Server.SqlProcedure()] public static void StoredProcExecuteCommand(int rating) { // Connect through the context connection. using (SqlConnection connection = new SqlConnection("context connection=true")) { connection.Open(); 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. SqlContext.Pipe.ExecuteAndSend(command); }
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.
