SqlPipe Class

Note: This class is new in the .NET Framework version 2.0.

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 NotInheritable Class SqlPipe
Dim instance As SqlPipe

public final class SqlPipe
public final class SqlPipe

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 uses a SqlPipe to execute the command and send the results back to the client.

<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")

        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
    End Using
End Sub


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

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

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

.NET Framework

Supported in: 2.0

Community Additions