SqlParameterCollection.Add 方法

定义

重载

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:
 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 对象。

例外

value 参数中指定的 SqlParameter 已经添加到这个或其他 SqlParameterCollection 中。

传递的参数不是 SqlParameter

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

返回

新的 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 值之一。

返回

一个新 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, 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:
 Microsoft::Data::SqlClient::SqlParameter ^ Add(System::String ^ parameterName, System::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 Microsoft.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)>]
override this.Add : string * obj -> Microsoft.Data.SqlClient.SqlParameter
Public Function Add (parameterName As String, value As Object) As SqlParameter

参数

parameterName
String

要添加到集合的 SqlParameter 的名称。

value
Object

Object

返回

一个新 SqlParameter 对象。

使用 SqlParameterCollection.Add 方法的重载来指定整数参数值时,请务必谨慎。 因为此重载接受 Object 类型的 value,所以当此值为零时,必须将整数值转换为 Object 类型,如下面的 C# 示例所示。

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

如果不执行此转换,编译器将假定您正尝试调用 SqlParameterCollection.Add (stringSqlDbType) 重载。

属性

例外

value 参数中指定的 SqlParameter 已经添加到这个或其他 SqlParameterCollection 中。

value 参数为 null。

示例

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);
    }
}

适用于

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

要添加到集合中的 SqlParameterSqlDbType

size
Int32

Int32 的大小。

返回

一个新 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);
    }
}

注解

添加长度可变数据类型的参数(如 varcharbinary)时,此重载非常有用。

适用于

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

size
Int32

列的长度。

sourceColumn
String

源列名 (SourceColumn)(如果在调用 Update(DataSet) 中使用了此 SqlParameter)。

返回

一个新 SqlParameter 对象。

示例

using Microsoft.Data.SqlClient;

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

适用于