SqlParameterCollection.Remove Method

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Removes the specified SqlParameter from the collection.

Overloads

Remove(SqlParameter)	Removes the specified SqlParameter from the collection.
Remove(Object)	Removes the specified SqlParameter from the collection.

Remove(SqlParameter)

Source:

System.Data.SqlClient.notsupported.cs

Removes the specified SqlParameter from the collection.

C#

public void Remove(System.Data.SqlClient.SqlParameter value);

Parameters

value

SqlParameter

A SqlParameter object to remove from the collection.

Exceptions

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.

C#

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

See also

• Commands and Parameters (ADO.NET)
• DataAdapter Parameters (ADO.NET)
• Using the .NET Framework Data Provider for SQL Server
• ADO.NET Overview

Remove(Object)

Source:

System.Data.SqlClient.notsupported.cs

Removes the specified SqlParameter from the collection.

C#

public override void Remove(object value);

Parameters

value

Object

The object to remove from the collection.

Examples

The following example demonstrates the implementation of the IList interface to create a simple, fixed-size list. This code is part of a larger example for the IList interface.

C#

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

Remarks

This member is an explicit interface member implementation. It can be used only when the SqlParameterCollection instance is cast to an IList interface.

In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table. If value is not found in the IList, the IList remains unchanged and no exception is thrown.

See also

• Commands and Parameters (ADO.NET)
• DataAdapter Parameters (ADO.NET)
• Using the .NET Framework Data Provider for SQL Server
• ADO.NET Overview