PropertyCollection::IDictionary::Remove Method (Object^)

 

Removes the element with the specified key from the IDictionary object.

Namespace:   System.DirectoryServices
Assembly:  System.DirectoryServices (in System.DirectoryServices.dll)

private:
virtual void Remove(
	Object^ key
) sealed = IDictionary::Remove

Parameters

key
Type: System::Object^

The key of the element to remove.

Exception Condition
ArgumentNullException

key is null.

NotSupportedException

The IDictionary object is read-only.

-or-

The IDictionary has a fixed size.

The following example shows how to implement the Remove method. This code example is part of a larger example provided for the IDictionary class.

public:
    virtual void Remove(Object^ key)
    {
        if (key == nullptr)
        {
            throw gcnew ArgumentNullException("key");
        }
        // Try to find the key in the DictionaryEntry array
        int index;
        if (TryGetIndexOfKey(key, &index))
        {
            // If the key is found, slide all the items down.
            Array::Copy(items, index + 1, items, index, itemsInUse -
                index - 1);
            itemsInUse--;
        }
        else
        {
            // If the key is not in the dictionary, just return.
            return;
        }
    }

.NET Framework
Available since 1.1
Return to top
Show: