SqlCommand.ExecuteScalar メソッド

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

SqlCommand.ExecuteScalar メソッド

クエリを実行し、そのクエリが返す結果セットの最初の行にある最初の列を返します。残りの列または行は無視されます。

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

Visual Basic (宣言)

Public Overrides Function
 ExecuteScalar As Object

Visual Basic (使用法)

Dim instance As SqlCommand
Dim returnValue As Object

returnValue = instance.ExecuteScalar

C#

public override Object ExecuteScalar ()

C++

public:
virtual Object^ ExecuteScalar () override

J#

public Object ExecuteScalar ()

JScript

public override function ExecuteScalar () :
 Object

戻り値
結果セットの最初の行の最初の列。結果セットが空の場合は、null 参照。

例外

例外の種類	条件
SqlException	ロックされている行に対してコマンドを実行しているときに例外が発生しました。この例外は .NET Framework Version 1.0 を使用している場合は生成されません。

解説

ExecuteScalar メソッドを使用して、データベースから単一の値 (集計値など) を取得します。ExecuteReader メソッドを使用し、SqlDataReader によって返されたデータから単一値を生成するよりも、このメソッドを使用した方がコードが簡潔になります。

ExecuteScalar クエリは、通常、次の形式で指定します。この例は、C# のコード例です。

 cmd.CommandText = "SELECT COUNT(*) FROM dbo.region";
 Int32 count = (Int32) cmd.ExecuteScalar();

使用例

SqlCommand を作成し、ExecuteScalar を使用して実行する例を次に示します。この例は、テーブルに挿入する新しい値 (文字列) と、データ ソースへの接続文字列を引数として受け取ります。行の挿入に成功した場合は新しい ID 列値を、失敗した場合は 0 を返します。

Visual Basic

Public Function AddProductCategory( _
  ByVal newName As String,
 ByVal connString As String)
 As Integer
    Dim newProdID As Int32 = 0
    Dim sql As String =
 _
     "INSERT INTO Production.ProductCategory (Name) VALUES (@Name);
 " _
       & "SELECT CAST(scope_identity() AS int);"

    Using conn As New SqlConnection(connString)
        Dim cmd As New SqlCommand(sql,
 conn)
        cmd.Parameters.Add("@Name", SqlDbType.VarChar)
        cmd.Parameters("@Name").Value = newName
        Try
            conn.Open()
            newProdID = Convert.ToInt32(cmd.ExecuteScalar())
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Using

    Return newProdID
End Function

C#

static public int AddProductCategory(string
 newName, string connString)
{
    Int32 newProdID = 0;
    string sql =
        "INSERT INTO Production.ProductCategory (Name) VALUES (@Name); "
        + "SELECT CAST(scope_identity() AS int)";
    using (SqlConnection conn = new SqlConnection(connString))
    {
        SqlCommand cmd = new SqlCommand(sql, conn);
        cmd.Parameters.Add("@Name", SqlDbType.VarChar);
        cmd.Parameters["@name"].Value = newName;
        try
        {
            conn.Open();
            newProdID = (Int32)cmd.ExecuteScalar();
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
    return (int)newProdID;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SqlCommand クラス
SqlCommand メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用