SqlPipe

.NET Framework クラス ライブラリ リファレンス

SqlPipe クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

このクラスを使用すると、SQL Server データベース上でインプロセスで実行されるマネージ ストアド プロシージャから、呼び出し元に結果を返すことができます。このクラスは継承できません。

名前空間: Microsoft.SqlServer.Server
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 SqlPipe

Visual Basic (使用法)

Dim instance As SqlPipe

C#

public sealed class SqlPipe

C++

public ref class SqlPipe sealed

J#

public final class SqlPipe

JScript

public final class SqlPipe

解説

マネージ ストアド プロシージャは、SqlContext クラスの Pipe プロパティを通じてこのクラスのインスタンスにアクセスできます。

使用例

次の例では、まず、ストアド プロシージャで、SqlConnection および SqlCommand を使用し、データ ソースから行を選択します。次に、SqlPipe を使用してコマンドを実行し、結果をクライアントに返しています。

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);
        
    }

継承階層

System.Object
  Microsoft.SqlServer.Server.SqlPipe

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlPipe メンバ
Microsoft.SqlServer.Server 名前空間

SqlPipe プロパティ

パブリック プロパティ

	名前	説明
	IsSendingResults	SqlPipe に、単一の結果セットをクライアントに返すモードが使用されているかどうかを示す値を取得しますこのプロパティは読み取り専用です。

参照

関連項目

SqlPipe クラス
Microsoft.SqlServer.Server 名前空間

SqlPipe メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	ExecuteAndSend	パラメータとして渡されたコマンドを実行し、結果をクライアントに返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Send	オーバーロードされます。 実行結果をクライアントに直接送信します。
	SendResultsEnd	結果セットの最後に到達したことを示し、SqlPipe インスタンスを初期状態に戻します。
	SendResultsRow	単一行のデータをクライアントに返します。
	SendResultsStart	クライアントに返す結果セットの先頭を宣言し、record パラメータを使用して結果セットを表すメタデータを構築します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

SqlPipe クラス
Microsoft.SqlServer.Server 名前空間

SqlPipe メンバ

このクラスを使用すると、SQL Server データベース上でインプロセスで実行されるマネージ ストアド プロシージャから、呼び出し元に結果を返すことができます。このクラスは継承できません。

SqlPipe データ型で公開されるメンバを以下の表に示します。

パブリック プロパティ

	名前	説明
	IsSendingResults	SqlPipe に、単一の結果セットをクライアントに返すモードが使用されているかどうかを示す値を取得しますこのプロパティは読み取り専用です。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	ExecuteAndSend	パラメータとして渡されたコマンドを実行し、結果をクライアントに返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Send	オーバーロードされます。 実行結果をクライアントに直接送信します。
	SendResultsEnd	結果セットの最後に到達したことを示し、SqlPipe インスタンスを初期状態に戻します。
	SendResultsRow	単一行のデータをクライアントに返します。
	SendResultsStart	クライアントに返す結果セットの先頭を宣言し、record パラメータを使用して結果セットを表すメタデータを構築します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

SqlPipe クラス
Microsoft.SqlServer.Server 名前空間