Array.Clear Method (System)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
Array.Clear Method

Sets a range of elements in the Array to zero, to false, or to a null reference (Nothing in Visual Basic), depending on the element type.

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

Syntax
Visual Basic (Declaration)
Public Shared Sub Clear ( _
	array As Array, _
	index As Integer, _
	length As Integer _
)
Visual Basic (Usage)
Dim array As Array
Dim index As Integer
Dim length As Integer

Array.Clear(array, index, length)
C#
public static void Clear (
	Array array,
	int index,
	int length
)
C++
public:
static void Clear (
	Array^ array, 
	int index, 
	int length
)
J#
public static void Clear (
	Array array, 
	int index, 
	int length
)
JScript
public static function Clear (
	array : Array, 
	index : int, 
	length : int
)

Parameters

array

The Array whose elements need to be cleared.

index

The starting index of the range of elements to clear.

length

The number of elements to clear.

Exceptions
Exception type Condition

ArgumentNullException

array is a null reference (Nothing in Visual Basic).

IndexOutOfRangeException

index is less than the lower bound of array.

-or-

length is less than zero.

-or-

The sum of index and length is greater than the size of the Array.
Remarks

Reference-type elements are set to a null reference (Nothing in Visual Basic). Boolean-type elements are set to false. Other value-type elements are set to zero.

This method only clears the values of the elements; it does not delete the elements themselves. An Array has a fixed size; therefore, elements cannot be added or removed.

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

Platforms

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
See Also