IDbCommand.ExecuteScalar メソッド

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

IDbCommand.ExecuteScalar メソッド

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

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

Visual Basic (宣言)

Function ExecuteScalar As Object

Visual Basic (使用法)

Dim instance As IDbCommand
Dim returnValue As Object

returnValue = instance.ExecuteScalar

C#

Object ExecuteScalar ()

C++

Object^ ExecuteScalar ()

J#

Object ExecuteScalar ()

JScript

function ExecuteScalar () : Object

戻り値
結果セットの最初の行にある最初の列。

解説

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

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

 CommandText = "select count(*) as NumberOfRegions from region";
 Int32 count = (int) ExecuteScalar();

使用例

派生クラス SqlCommand のインスタンスを作成し、ExecuteScalar を使用してこのインスタンスを実行する例を次に示します。この例では、集計結果を返す Transact-SQL ステートメントである文字列と、データ ソースに接続するために使用する文字列を渡します。

Visual Basic

Public Sub CreateSqlCommand( _
    queryString As String, connection As
 SqlConnection)

    Dim command As New SqlCommand(queryString,
 connection)
    command.Connection.Open()
    command.ExecuteScalar()
    connection.Close()
End Sub

C#

public void CreateSqlCommand(
    string queryString, SqlConnection connection) 
{
    SqlCommand command = new 
        SqlCommand(queryString, connection);
    command.Connection.Open();
    command.ExecuteScalar();
    connection.Close();
}

プラットフォーム

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

参照

関連項目
IDbCommand インターフェイス
IDbCommand メンバ
System.Data 名前空間