SqlPipe.SendResultsRow メソッド

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

SqlPipe.SendResultsRow メソッド

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

単一行のデータをクライアントに返します。

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

Visual Basic (宣言)

Public Sub SendResultsRow ( _
    record As SqlDataRecord _
)

Visual Basic (使用法)

Dim instance As SqlPipe
Dim record As SqlDataRecord

instance.SendResultsRow(record)

C#

public void SendResultsRow (
    SqlDataRecord record
)

C++

public:
void SendResultsRow (
    SqlDataRecord^ record
)

J#

public void SendResultsRow (
    SqlDataRecord record
)

JScript

public function SendResultsRow (
    record : SqlDataRecord
)

パラメータ

record

クライアントに送信する行の列値を含む SqlDataRecord オブジェクト。このレコードのスキーマは、SendResultsStart メソッドに渡した SqlDataRecord のメタデータが定義するスキーマと一致している必要があります。

例外

例外の種類	条件
ArgumentNullException	record が null 参照 (Visual Basic では Nothing) です。
InvalidOperationException	SendResultsStart メソッドがまだ呼び出されていません。

解説

マネージ ストアド プロシージャは、SqlDataReader を実装していないクライアントに対して結果セットを送信できます。このメソッドを、SendResultsStart および SendResultsEnd と組み合わせて使用することで、ストアド プロシージャからクライアントに対し、カスタムの結果セットを送信できます。

SendResultsRow メソッドは、単一行のデータをクライアントに返します。その後、呼び出し元に行を返すには、対象の行ごとに SendResultsRow を呼び出します。すべての行を送信した後は、SendResultsEnd メソッドを呼び出して、結果セットの最後に到達したことを示す必要があります。

使用例

次の例では、新しい SqlDataRecord と、その SqlMetaData オブジェクトを作成します。さらに、SendResultsStart メソッドで結果セットの先頭を宣言し、サンプルのデータを含むレコードを、SendResultsRow メソッドでクライアントに返した後、結果セットの最後に到達したことを、SendResultsEnd メソッドを使って示しています。

Visual Basic

<Microsoft.SqlServer.Server.SqlProcedure()> _
Public Shared Sub StoredProcReturnResultSet()

    ' Create the record and specify the metadata for the columns.
    Dim record As New SqlDataRecord(
 _
        New SqlMetaData("col1",
 SqlDbType.NVarChar, 100), _
        New SqlMetaData("col2",
 SqlDbType.Int))

    ' Mark the begining of the result-set.
    SqlContext.Pipe.SendResultsStart(record)

    ' Send 10 rows back to the client.
    Dim i As Integer
    For i = 0 To 9

        ' Set values for each column in the row.
        record.SetString(0, "row " & i.ToString())
        record.SetInt32(1, i)

        ' Send the row back to the client.
        SqlContext.Pipe.SendResultsRow(record)
    Next

    ' Mark the end of the result-set.
    SqlContext.Pipe.SendResultsEnd()
End Sub

C#

[Microsoft.SqlServer.Server.SqlProcedure]
public static void StoredProcReturnResultSet()
{
    // Create the record and specify the metadata for the columns.
    SqlDataRecord record = new SqlDataRecord(
        new SqlMetaData("col1", SqlDbType.NVarChar,
 100),
        new SqlMetaData("col2", SqlDbType.Int));

    // Mark the begining of the result-set.
    SqlContext.Pipe.SendResultsStart(record);

    // Send 10 rows back to the client.
    for (int i = 0; i < 10; i++)
    {
        // Set values for each column in the row.
        record.SetString(0, "row " + i.ToString());
        record.SetInt32(1, i);

        // Send the row back to the client.
        SqlContext.Pipe.SendResultsRow(record);
    }

    // Mark the end of the result-set.
    SqlContext.Pipe.SendResultsEnd();
}

プラットフォーム

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 クラス
SqlPipe メンバ
Microsoft.SqlServer.Server 名前空間
SendResultsStart
SendResultsEnd