SqlParameterCollection.Add メソッド

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

オーバーロード

Add(SqlParameter)	指定した SqlParameter オブジェクトを SqlParameterCollection に追加します。
Add(Object)	指定した SqlParameter オブジェクトを SqlParameterCollection に追加します。
Add(String, SqlDbType)	指定されたパラメーター名とデータ型を持つ SqlParameter を SqlParameterCollection に追加します。
Add(String, SqlDbType, Int32)	パラメーター名、SqlParameter、およびサイズを指定して、SqlParameterCollection を SqlDbType に追加します。
Add(String, SqlDbType, Int32, String)	指定されたパラメーター名、データ型、および列長を持つ SqlParameter を SqlParameterCollection に追加します。

Add(SqlParameter)

指定した SqlParameter オブジェクトを SqlParameterCollection に追加します。

public:
 Microsoft::Data::SqlClient::SqlParameter ^ Add(Microsoft::Data::SqlClient::SqlParameter ^ value);

public Microsoft.Data.SqlClient.SqlParameter Add (Microsoft.Data.SqlClient.SqlParameter value);

override this.Add : Microsoft.Data.SqlClient.SqlParameter -> Microsoft.Data.SqlClient.SqlParameter

Public Function Add (value As SqlParameter) As SqlParameter

パラメーター

value

SqlParameter

コレクションに追加する SqlParameter。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

例外

ArgumentException

value パラメーターで指定された SqlParameter は、既にこの、または他の SqlParameterCollection に追加されています。

InvalidCastException

渡されたパラメーターが SqlParameter ではありません。

ArgumentNullException

value パラメーターが null です。

例

using Microsoft.Data.SqlClient;

public class Sample
{
    public void AddSqlParameter(SqlCommand command)
    {
        command.Parameters.Add(new SqlParameter("Description", "Beverages"));
    }
}

Add(Object)

指定した SqlParameter オブジェクトを SqlParameterCollection に追加します。

public:
 override int Add(System::Object ^ value);

public override int Add (object value);

override this.Add : obj -> int

Public Overrides Function Add (value As Object) As Integer

パラメーター

value

Object

Object。

戻り値

Int32

新しい SqlParameter オブジェクトのインデックス。

Add(String, SqlDbType)

指定されたパラメーター名とデータ型を持つ SqlParameter を SqlParameterCollection に追加します。

public:
 Microsoft::Data::SqlClient::SqlParameter ^ Add(System::String ^ parameterName, System::Data::SqlDbType sqlDbType);

public Microsoft.Data.SqlClient.SqlParameter Add (string parameterName, System.Data.SqlDbType sqlDbType);

override this.Add : string * System.Data.SqlDbType -> Microsoft.Data.SqlClient.SqlParameter

Public Function Add (parameterName As String, sqlDbType As SqlDbType) As SqlParameter

パラメーター

parameterName

String

パラメーターの名前。

sqlDbType

SqlDbType

SqlDbType 値のいずれか 1 つ。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

例

using Microsoft.Data.SqlClient;

public class Sample
{
    public void AddSqlParameter(SqlCommand command)
    {
        SqlParameter param = command.Parameters.Add(
            "@Description", SqlDbType.NVarChar);
        param.Size = 16;
        param.Value = "Beverages";
    }
}

Add(String, SqlDbType, Int32)

パラメーター名、SqlParameter、およびサイズを指定して、SqlParameterCollection を SqlDbType に追加します。

public:
 Microsoft::Data::SqlClient::SqlParameter ^ Add(System::String ^ parameterName, System::Data::SqlDbType sqlDbType, int size);

public Microsoft.Data.SqlClient.SqlParameter Add (string parameterName, System.Data.SqlDbType sqlDbType, int size);

override this.Add : string * System.Data.SqlDbType * int -> Microsoft.Data.SqlClient.SqlParameter

Public Function Add (parameterName As String, sqlDbType As SqlDbType, size As Integer) As SqlParameter

パラメーター

parameterName

String

パラメーターの名前。

sqlDbType

SqlDbType

コレクションに追加する SqlParameter の SqlDbType。

size

Int32

Int32 としてのサイズ。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

例

using Microsoft.Data.SqlClient;

public class Sample
{
    public void AddSqlParameter(SqlCommand command)
    {
        SqlParameter param = new SqlParameter(
            "@Description", SqlDbType.NVarChar, 16);
        param.Value = "Beverages";
        command.Parameters.Add(param);
    }
}

注釈

このオーバーロードは、 や binaryなどのvarchar可変長データ型のパラメーターを追加する場合に便利です。

Add(String, SqlDbType, Int32, String)

指定されたパラメーター名、データ型、および列長を持つ SqlParameter を SqlParameterCollection に追加します。

public:
 Microsoft::Data::SqlClient::SqlParameter ^ Add(System::String ^ parameterName, System::Data::SqlDbType sqlDbType, int size, System::String ^ sourceColumn);

public Microsoft.Data.SqlClient.SqlParameter Add (string parameterName, System.Data.SqlDbType sqlDbType, int size, string sourceColumn);

override this.Add : string * System.Data.SqlDbType * int * string -> Microsoft.Data.SqlClient.SqlParameter

Public Function Add (parameterName As String, sqlDbType As SqlDbType, size As Integer, sourceColumn As String) As SqlParameter

パラメーター

parameterName

String

パラメーターの名前。

sqlDbType

SqlDbType

SqlDbType 値のいずれか 1 つ。

size

Int32

列の長さ。

sourceColumn

String

Update(DataSet) に対する呼び出しでこの SqlParameter が使用されている場合の、ソース列 (SourceColumn) の名前。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

例

using Microsoft.Data.SqlClient;

public class Sample
{
    public void AddSqlParameter(SqlCommand cmd)
    {
        SqlParameter p1 = cmd.Parameters.Add("@Description", SqlDbType.NVarChar, 16, "Description");
    }
}