.NET Framework Class Library
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)
Syntax

Visual Basic (Declaration)
Public NotInheritable Class SqlPipe
Visual Basic (Usage)
Dim instance As SqlPipe
C#
public sealed class SqlPipe
Visual C++
public ref class SqlPipe sealed
JScript
public final class SqlPipe
Remarks

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

Examples

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.

Visual Basic
<Microsoft.SqlServer.Server.SqlProcedure()> _
Public Shared Sub StoredProcExecuteCommand(ByVal rating As Integer)
    Dim command As SqlCommand

    ' Connect through the context connection
    Using connection As New SqlConnection("context connection=true")
        connection.Open()

        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)
    End Using
End Sub
C#
    [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);
            
        }
Inheritance Hierarchy

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

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker