This documentation is archived and is not being maintained.

Hashtable.Clear Method

Removes all elements from the Hashtable.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

public function Clear()

Implements

IDictionary.Clear()

ExceptionCondition
NotSupportedException

The Hashtable is read-only.

Count is set to zero, and references to other objects from elements of the collection are also released. The capacity remains unchanged.

This method is an O(n) operation, where n is Count.

The following example shows how to clear the values of the Hashtable.

import System
import System.Collections
import Microsoft.VisualBasic

// Creates and initializes a new Hashtable.
var myHT : Hashtable = new Hashtable()
myHT.Add("one", "The")
myHT.Add("two", "quick")
myHT.Add("three", "brown")
myHT.Add("four", "fox")
myHT.Add("five", "jumped")

// Displays the count and values of the Hashtable.
Console.WriteLine("Initially,")
Console.WriteLine("   Count    : {0}", myHT.Count)
Console.WriteLine("   Values:")
PrintKeysAndValues(myHT)

// Clears the Hashtable.
myHT.Clear()

// Displays the count and values of the Hashtable.
Console.WriteLine("After Clear,")
Console.WriteLine("   Count    : {0}", myHT.Count)
Console.WriteLine("   Values:")
PrintKeysAndValues(myHT)

function PrintKeysAndValues(myList : Hashtable){
    var myEnumerator : IDictionaryEnumerator = myList.GetEnumerator()
    Console.WriteLine("\t-KEY-\t-VALUE-")
    while(myEnumerator.MoveNext())
        Console.WriteLine("\t{0}:\t{1}", myEnumerator.Key, myEnumerator.Value)
    Console.WriteLine()
}

// This code produces the following output.
// 
// Initially,
//    Count    : 5
//    Values:
//     -KEY-    -VALUE-
//     five:    jumped
//     three:   brown
//     four:    fox
//     two:     quick
//     one:     The
// 
// After Clear,
//    Count    : 0
//    Values:
//     -KEY-    -VALUE- 

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: