This topic has not yet been rated - Rate this topic

SqlParameterCollection.Remove Method (SqlParameter)

.NET Framework 4.5

Removes the specified SqlParameter from the collection.

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

public void Remove(
	SqlParameter value
)

Parameters

value: Type: System.Data.SqlClient.SqlParameter
A SqlParameter object to remove from the collection.

Exceptions

Exception	Condition
InvalidCastException	The parameter is not a SqlParameter.
SystemException	The parameter does not exist in the collection.

Examples

The following example searches for a SqlParameter object in a SqlParameterCollection collection. If the parameter exists, the example removes it. This example assumes that a SqlParameterCollection collection has already been created by a SqlCommand.

public void SearchSqlParams() 
{
    // ... 
    // create SqlCommand command and SqlParameter param 
    // ... 
    if (command.Parameters.Contains(param))
        command.Parameters.Remove(param);
}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

SqlParameterCollection Class

Remove Overload

System.Data.SqlClient Namespace

Other Resources

Commands and Parameters (ADO.NET)

DataAdapter Parameters (ADO.NET)

SQL Server and ADO.NET

ADO.NET Managed Providers and DataSet Developer Center

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)