SqlCommand.Parameters プロパティ

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

SqlCommand.Parameters プロパティ

SqlParameterCollection を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Parameters As SqlParameterCollection

Visual Basic (使用法)

Dim instance As SqlCommand
Dim value As SqlParameterCollection

value = instance.Parameters

C#

public SqlParameterCollection Parameters { get;
 }

C++

public:
property SqlParameterCollection^ Parameters {
    SqlParameterCollection^ get ();
}

J#

/** @property */
public SqlParameterCollection get_Parameters ()

JScript

public function get Parameters
 () : SqlParameterCollection

プロパティ値
Transact-SQL ステートメントまたはストアド プロシージャのパラメータ。既定値は空のコレクションです。

解説

Microsoft .NET Framework SQL Server 用データ プロバイダでは、CommandType.Text のコマンドで呼び出す SQL ステートメントまたはストアド プロシージャにパラメータを渡すために、疑問符 (?) のプレースホルダは利用できません。この場合は、名前付きパラメータを使用する必要があります。次に例を示します。

SELECT * FROM Customers WHERE CustomerID = @CustomerID

メモ
コレクションのパラメータが、実行するクエリの要件と一致しない場合は、エラーが発生することがあります。

詳細については、「コマンドによるストアド プロシージャの使用」を参照してください。

使用例

SqlCommand を作成し、そのパラメータを表示する例を次に示します。この例では、SqlConnection、Transact-SQL SELECT ステートメントのクエリ文字列、および SqlParameter オブジェクトの配列がメソッドに渡されます。

Visual Basic

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

    Dim command As New SqlCommand(queryString,
 connection)
    command.CommandText = _
       "SELECT CustomerID, CompanyName FROM Customers "
 _
       & "WHERE Country = @Country AND City = @City"
    command.UpdatedRowSource = UpdateRowSource.Both
    command.Parameters.Add(params)

    Dim j As Integer
    For j = 0 To command.Parameters.Count -
 1
        command.Parameters.Add(params(j))
    Next j

    Dim message As String
 = ""
    Dim i As Integer
    For i = 0 To command.Parameters.Count -
 1
        message += command.Parameters(i).ToString() & ControlChars.Cr
    Next i

    Console.WriteLine(message)
End Sub

C#

public void CreateSqlCommand(SqlConnection
 myConnection,
    string queryString, SqlParameter[] paramArray) 
{
    SqlCommand command = new SqlCommand(queryString, myConnection);
    command.CommandText = 
        "SELECT CustomerID, CompanyName FROM Customers " 
        + "WHERE Country = @Country AND City = @City";    
    command.Parameters.Add(paramArray);

    for (int j=0; j<paramArray.Length; j++)
    {
        command.Parameters.Add(paramArray[j]) ;
    }

    string message = "";
    for (int i = 0; i < command.Parameters.Count;
 i++) 
    {
        message += command.Parameters[i].ToString() + "\n";
    }
    Console.WriteLine(message);
}

プラットフォーム

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 の使用