SqlParameterCollection.Add メソッド

リファレンス

定義

名前空間:: System.Data.SqlClient

アセンブリ:: System.Data.SqlClient.dll

アセンブリ:: System.Data.dll

アセンブリ:: netstandard.dll, System.Data.SqlClient.dll

パッケージ:: System.Data.SqlClient v4.8.6

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

SqlParameter を SqlParameterCollection に追加します。

オーバーロード

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

Add(SqlParameter)

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

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

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

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

member this.Add : System.Data.SqlClient.SqlParameter -> System.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 です。

例

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

Public Sub AddSqlParameter(command As SqlCommand) 
  command.Parameters.Add(New SqlParameter("Description", "Beverages"))
End Sub

こちらもご覧ください

適用対象

Add(Object)

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

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

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

public override int Add (object value);

public int Add (object value);

override this.Add : obj -> int

abstract member Add : obj -> int
override this.Add : obj -> int

Public Overrides Function Add (value As Object) As Integer

Public Function Add (value As Object) As Integer

パラメーター

value: Object

Object。

戻り値

Int32

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

実装

Add(Object)

例

次の例では、インターフェイスを IList 実装して、単純な固定サイズのリストを作成する方法を示します。このコードは、インターフェイスの大きな例の IList 一部です。

class SimpleList : IList
{
    private object[] _contents = new object[8];
    private int _count;

    public SimpleList()
    {
        _count = 0;
    }

    // IList Members
    public int Add(object value)
    {
        if (_count < _contents.Length)
        {
            _contents[_count] = value;
            _count++;

            return (_count - 1);
        }

        return -1;
    }

    public void Clear()
    {
        _count = 0;
    }

    public bool Contains(object value)
    {
        for (int i = 0; i < Count; i++)
        {
            if (_contents[i] == value)
            {
                return true;
            }
        }
        return false;
    }

    public int IndexOf(object value)
    {
        for (int i = 0; i < Count; i++)
        {
            if (_contents[i] == value)
            {
                return i;
            }
        }
        return -1;
    }

    public void Insert(int index, object value)
    {
        if ((_count + 1 <= _contents.Length) && (index < Count) && (index >= 0))
        {
            _count++;

            for (int i = Count - 1; i > index; i--)
            {
                _contents[i] = _contents[i - 1];
            }
            _contents[index] = value;
        }
    }

    public bool IsFixedSize
    {
        get
        {
            return true;
        }
    }

    public bool IsReadOnly
    {
        get
        {
            return false;
        }
    }

    public void Remove(object value)
    {
        RemoveAt(IndexOf(value));
    }

    public void RemoveAt(int index)
    {
        if ((index >= 0) && (index < Count))
        {
            for (int i = index; i < Count - 1; i++)
            {
                _contents[i] = _contents[i + 1];
            }
            _count--;
        }
    }

    public object this[int index]
    {
        get
        {
            return _contents[index];
        }
        set
        {
            _contents[index] = value;
        }
    }

    // ICollection members.

    public void CopyTo(Array array, int index)
    {
        for (int i = 0; i < Count; i++)
        {
            array.SetValue(_contents[i], index++);
        }
    }

    public int Count
    {
        get
        {
            return _count;
        }
    }

    public bool IsSynchronized
    {
        get
        {
            return false;
        }
    }

    // Return the current instance since the underlying store is not
    // publicly available.
    public object SyncRoot
    {
        get
        {
            return this;
        }
    }

    // IEnumerable Members

    public IEnumerator GetEnumerator()
    {
        // Refer to the IEnumerator documentation for an example of
        // implementing an enumerator.
        throw new NotImplementedException("The method or operation is not implemented.");
    }

    public void PrintContents()
    {
        Console.WriteLine($"List has a capacity of {_contents.Length} and currently has {_count} elements.");
        Console.Write("List contents:");
        for (int i = 0; i < Count; i++)
        {
            Console.Write($" {_contents[i]}");
        }
        Console.WriteLine();
    }
}

Public Class SimpleList
    Implements IList

    Private _contents(7) As Object
    Private _count As Integer

    Public Sub New()

        _count = 0
    End Sub

    ' IList members.
    Public Function Add(ByVal value As Object) As Integer Implements IList.Add
        If _count < _contents.Length Then
            _contents(_count) = value
            _count += 1

            Return _count - 1
        End If

        Return -1
    End Function

    Public Sub Clear() Implements IList.Clear
        _count = 0
    End Sub

    Public Function Contains(ByVal value As Object) As Boolean Implements IList.Contains
        For i As Integer = 0 To Count - 1
            If _contents(i) = value Then Return True
        Next

        Return False
    End Function

    Public Function IndexOf(ByVal value As Object) As Integer Implements IList.IndexOf
        For i As Integer = 0 To Count - 1
            If _contents(i) = value Then Return i
        Next
        Return -1
    End Function

    Public Sub Insert(ByVal index As Integer, ByVal value As Object) Implements IList.Insert

        If _count + 1 <= _contents.Length AndAlso index < Count AndAlso index >= 0 Then
            _count += 1

            For i As Integer = Count - 1 To index Step -1
                _contents(i) = _contents(i - 1)
            Next
            _contents(index) = value
        End If
    End Sub

    Public ReadOnly Property IsFixedSize() As Boolean Implements IList.IsFixedSize
        Get
            Return True
        End Get
    End Property

    Public ReadOnly Property IsReadOnly() As Boolean Implements IList.IsReadOnly
        Get
            Return False
        End Get
    End Property

    Public Sub Remove(ByVal value As Object) Implements IList.Remove
        RemoveAt(IndexOf(value))
    End Sub

    Public Sub RemoveAt(ByVal index As Integer) Implements IList.RemoveAt

        if index >= 0 AndAlso index < Count Then
            for i As Integer = index To Count - 2
                _contents(i) = _contents(i + 1)
            Next
            _count -= 1
        End If
    End Sub

    Public Property Item(ByVal index As Integer) As Object Implements IList.Item
        Get
            Return _contents(index)
        End Get

        Set(ByVal value As Object)
            _contents(index) = value
        End Set
    End Property

    ' ICollection members.
    Public Sub CopyTo(ByVal array As Array, ByVal index As Integer) Implements ICollection.CopyTo
        For i As Integer = 0 To Count - 1
            array.SetValue(_contents(i), index)
            index += 1
        Next
    End Sub

    Public ReadOnly Property Count() As Integer Implements ICollection.Count
        Get
            Return _count
        End Get
    End Property

    Public ReadOnly Property IsSynchronized() As Boolean Implements ICollection.IsSynchronized
        Get
            Return False
        End Get
    End Property

    ' Return the current instance since the underlying store is not
    ' publicly available.
    Public ReadOnly Property SyncRoot() As Object Implements ICollection.SyncRoot
        Get
            Return Me
        End Get
    End Property

    ' IEnumerable members.
    Public Function GetEnumerator() As IEnumerator Implements IEnumerable.GetEnumerator

        ' Refer to the IEnumerator documentation for an example of
        ' implementing an enumerator.
        Throw New NotImplementedException("The method or operation is not implemented.")
    End Function

    Public Sub PrintContents()
        Console.WriteLine($"List has a capacity of {_contents.Length} and currently has {_count} elements.")
        Console.Write("List contents:")

        For i As Integer = 0 To Count - 1
            Console.Write($" {_contents(i)}")
        Next

        Console.WriteLine()
    End Sub
End Class

注釈

このメンバーは、明示的なインターフェイスメンバーの実装です。これは、SqlParameterCollection のインスタンスが IList インターフェイスにキャストされる場合のみ、使用できます。

こちらもご覧ください

適用対象

Add(String, SqlDbType)

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

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

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

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

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

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

パラメーター

parameterName: String

パラメーターの名前。

sqlDbType: SqlDbType

SqlDbType 値のいずれか 1 つ。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

例

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

Public Sub AddSqlParameter(command As SqlCommand) 
  Dim param As SqlParameter = command.Parameters.Add( _
      "@Description", SqlDbType.NVarChar)
  param.Size = 16
  param.Value = "Beverages"
End Sub

こちらもご覧ください

適用対象

Add(String, Object)

注意事項

Add(String parameterName, Object value) has been deprecated. Use AddWithValue(String parameterName, Object value). http://go.microsoft.com/fwlink/?linkid=14202

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

public:
 System::Data::SqlClient::SqlParameter ^ Add(System::String ^ parameterName, System::Object ^ value);

public System.Data.SqlClient.SqlParameter Add (string parameterName, object value);

[System.Obsolete("Add(String parameterName, Object value) has been deprecated.  Use AddWithValue(String parameterName, Object value).  http://go.microsoft.com/fwlink/?linkid=14202", false)]
public System.Data.SqlClient.SqlParameter Add (string parameterName, object value);

member this.Add : string * obj -> System.Data.SqlClient.SqlParameter

[<System.Obsolete("Add(String parameterName, Object value) has been deprecated.  Use AddWithValue(String parameterName, Object value).  http://go.microsoft.com/fwlink/?linkid=14202", false)>]
override this.Add : string * obj -> System.Data.SqlClient.SqlParameter

Public Function Add (parameterName As String, value As Object) As SqlParameter

パラメーター

parameterName: String

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

value: Object

Object。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

SqlParameterCollection.Add メソッドのこのオーバーロードを使用して整数のパラメーター値を指定する場合は、注意する必要があります。このオーバーロードは Object 型の value を受け取るため、次の C# の例のように、値が 0 の場合に整数値を Object 型に変換する必要があります。

parameters.Add("@pname", Convert.ToInt32(0));

この変換を行わないと、コンパイラは、SqlParameterCollection.Add (string, SqlDbType) オーバーロードを呼び出そうとしていると見なします。

属性: ObsoleteAttribute

例外

ArgumentException

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

ArgumentNullException

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

例

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

Public Sub AddSqlParameter(command As SqlCommand) 
  Dim param As New SqlParameter( _
      "@Description", SqlDbType.NVarChar, 16)
  param.Value = "Beverages"
  command.Parameters.Add(param)
End Sub

こちらもご覧ください

ADO.NET の概要

適用対象

Add(String, SqlDbType, Int32)

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

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

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

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

member this.Add : string * System.Data.SqlDbType * int -> System.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 オブジェクト。

例

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

Public Sub AddSqlParameter(command As SqlCommand) 
  Dim param As New SqlParameter( _
      "@Description", SqlDbType.NVarChar, 16)
  param.Value = "Beverages"
  command.Parameters.Add(param)
End Sub

注釈

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

こちらもご覧ください

適用対象

Add(String, SqlDbType, Int32, String)

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

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

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

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

override this.Add : string * System.Data.SqlDbType * int * string -> System.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 に対する呼び出しでこの SqlParameter が使用されている場合の、ソース列 (SourceColumn) の名前。

戻り値

SqlParameter

新しい SqlParameter オブジェクト。

例

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

Public Sub AddSqlParameter(cmd As SqlCommand) 
  Dim p1 As SqlParameter = cmd.Parameters.Add("@Description", SqlDbType.NVarChar, 16, "Description")
End Sub

こちらもご覧ください

適用対象

次の方法で共有

SqlParameterCollection.Add メソッド

定義

オーバーロード

Add(SqlParameter)

パラメーター

戻り値

例外

例

こちらもご覧ください

適用対象

Add(Object)

パラメーター

戻り値

実装

例

注釈

こちらもご覧ください

適用対象

Add(String, SqlDbType)

パラメーター

戻り値

例

こちらもご覧ください

適用対象

Add(String, Object)

パラメーター

戻り値

例外

例

こちらもご覧ください

適用対象

Add(String, SqlDbType, Int32)

パラメーター

戻り値

例

注釈

こちらもご覧ください

適用対象

Add(String, SqlDbType, Int32, String)

パラメーター

戻り値

例

こちらもご覧ください

適用対象

その他のリソース