Export (0) Print
Expand All

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.

[Visual Basic]
Public Shared Sub Clear( _
   ByVal array As Array, _
   ByVal index As Integer, _
   ByVal length As Integer _
)
[C#]
public static void Clear(
 Array array,
 int index,
 int length
);
[C++]
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).
ArgumentOutOfRangeException 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.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

Array Class | Array Members | System Namespace | ICollection.Count

Show:
© 2014 Microsoft