SqlParameterCollection.Add Method (String, Object)

 
Note: This API is now obsolete.

Adds the specified SqlParameter object to the SqlParameterCollection.

Namespace:   System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

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

Parameters

parameterName
Type: System.String

The name of the SqlParameter to add to the collection.

value
Type: System.Object

A Object.

Return Value

Type: System.Data.SqlClient.SqlParameter

A new SqlParameter object.

Use caution when you are using this overload of the SqlParameterCollection.Add method to specify integer parameter values. Because this overload takes a value of type Object, you must convert the integral value to an Object type when the value is zero, as the following C# example demonstrates.

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

If you do not perform this conversion, the compiler assumes that you are trying to call the SqlParameterCollection.Add (string, SqlDbType) overload.

Exception Condition
ArgumentException

The SqlParameter specified in the value parameter is already added to this or another SqlParameterCollection.

ArgumentNullException

The value parameter is null.

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

.NET Framework
Available since 1.1
Return to top
Show: