StringDictionary::Remove Method (String^)
Removes the entry with the specified key from the string dictionary.
Assembly: System (in System.dll)
Parameters
- key
-
Type:
System::String^
The key of the entry to remove.
| Exception | Condition |
|---|---|
| ArgumentNullException | The key is null. |
| NotSupportedException | The StringDictionary is read-only. |
If the StringDictionary does not contain an element with the specified key, the StringDictionary remains unchanged. No exception is thrown.
The key is handled in a case-insensitive manner; it is translated to lowercase before it is used to find the entry to remove from the string dictionary.
This method is an O(1) operation.
The following code example demonstrates how to add and remove elements from a StringDictionary.
#using <System.dll> using namespace System; using namespace System::Collections; using namespace System::Collections::Specialized; void PrintKeysAndValues( StringDictionary^ myCol ) { Console::WriteLine( " KEY VALUE" ); IEnumerator^ enum0 = myCol->GetEnumerator(); while ( enum0->MoveNext() ) { DictionaryEntry^ de = safe_cast<DictionaryEntry^>(enum0->Current); Console::WriteLine( " {0,-10} {1}", de->Key, de->Value ); } Console::WriteLine(); } int main() { // Creates and initializes a new StringDictionary. StringDictionary^ myCol = gcnew StringDictionary; myCol->Add( "red", "rojo" ); myCol->Add( "green", "verde" ); myCol->Add( "blue", "azul" ); // Displays the values in the StringDictionary. Console::WriteLine( "Initial contents of the StringDictionary:" ); PrintKeysAndValues( myCol ); // Deletes an element. myCol->Remove( "green" ); Console::WriteLine( "The collection contains the following elements after removing \"green\":" ); PrintKeysAndValues( myCol ); // Clears the entire collection. myCol->Clear(); Console::WriteLine( "The collection contains the following elements after it is cleared:" ); PrintKeysAndValues( myCol ); } /* This code produces the following output. Initial contents of the StringDictionary: KEY VALUE green verde red rojo blue azul The collection contains the following elements after removing "green": KEY VALUE red rojo blue azul The collection contains the following elements after it is cleared: KEY VALUE */
Available since 10
.NET Framework
Available since 1.1