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

另請參閱

命令和參數 (ADO.NET)
DataAdapter 的參數 (ADO.NET)
使用 .NET Framework Data Provider for SQL Server
ADO.NET 概觀 \(部分機器翻譯\)

適用於

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 介面時，才能使用這個成員。

另請參閱

命令和參數 (ADO.NET)
DataAdapter 的參數 (ADO.NET)
使用 .NET Framework Data Provider for SQL Server
ADO.NET 概觀 \(部分機器翻譯\)

適用於

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 值。

傳回

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

另請參閱

命令和參數 (ADO.NET)
DataAdapter 的參數 (ADO.NET)
使用 .NET Framework Data Provider for SQL Server
ADO.NET 概觀 \(部分機器翻譯\)

適用於

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，因此您必須在值為零時將整數值轉換成 Object 型別，如下面的 C# 範例所示。

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

備註

當您新增變數長度數據類型的參數，例如 varchar 或 binary時，這個多載很有用。

另請參閱

命令和參數 (ADO.NET)
DataAdapter 的參數 (ADO.NET)
使用 .NET Framework Data Provider for SQL Server
ADO.NET 概觀 \(部分機器翻譯\)

適用於

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 值。

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

另請參閱

命令和參數 (ADO.NET)
DataAdapter 的參數 (ADO.NET)
使用 .NET Framework Data Provider for SQL Server
ADO.NET 概觀 \(部分機器翻譯\)

適用於

共用方式為

SqlParameterCollection.Add 方法

定義

多載

Add(SqlParameter)

參數

傳回

例外狀況

範例

另請參閱

適用於

Add(Object)

參數

傳回

實作

範例

備註

另請參閱

適用於

Add(String, SqlDbType)

參數

傳回

範例

另請參閱

適用於

Add(String, Object)

參數

傳回

例外狀況

範例

另請參閱

適用於

Add(String, SqlDbType, Int32)

參數

傳回

範例

備註

另請參閱

適用於

Add(String, SqlDbType, Int32, String)

參數

傳回

範例

另請參閱

適用於

其他資源