The exception that is thrown when an attempt is made to access an element of an array or collection with an index that is outside its bounds.
Assembly: mscorlib (in mscorlib.dll)
Thetype exposes the following members.
|IndexOutOfRangeException()||Initializes a new instance of the class.|
|IndexOutOfRangeException(String)||Initializes a new instance of the class with a specified error message.|
|IndexOutOfRangeException(String, Exception)||Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception.|
|Data||Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)|
|HelpLink||Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)|
|HResult||Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)|
|InnerException||Gets the Exception instance that caused the current exception. (Inherited from Exception.)|
|Message||Gets a message that describes the current exception. (Inherited from Exception.)|
|Source||Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)|
|StackTrace||Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)|
|TargetSite||Gets the method that throws the current exception. (Inherited from Exception.)|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|GetBaseException||When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)|
|GetHashCode||Serves as the default hash function. (Inherited from Object.)|
|GetObjectData||When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)|
|GetType||Gets the runtime type of the current instance. (Inherited from Exception.)|
In XNA Framework 3.0, this member is inherited from Object::GetType().
In Portable Class Library Portable Class Library, this member is inherited from Object::GetType().
In .NET for Windows Store apps Windows 8, this member is inherited from Object::GetType().
|ToString||Creates and returns a string representation of the current exception. (Inherited from Exception.)|
An exception is thrown when an invalid index is used to access a member of an array or a collection, or to read or write from a particular location in a buffer. This exception inherits from the Exception class but adds no unique members.
Typically, an exception is thrown as a result of developer error. Instead of handling the exception, you should diagnose the cause of the error and correct your code. The most common causes of the error are:
Forgetting that the upper bound of a collection or a zero-based array is one less than its number of members or elements, as the following example illustrates.
To correct the error, you can use code like the following.
Using a value returned by a search method to iterate a portion of an array or collection starting at a particular index position. If you forget to check whether the search operation found a match, the runtime throws an exception, as shown in this example.
In this case, the List<T>::IndexOf method returns -1, which is an invalid index value, when it fails to find a match. To correct this error, check the search method's return value before iterating the array, as shown in this example.
Trying to use or enumerate a result set, collection, or array returned by a query without testing whether the returned object has any valid data.
Using a computed value to define the starting index, the ending index, or the number of items to be iterated. If the result of the computation is unexpected, it might result in an exception. You should check your program's logic in calculating the index value and validate the value before iterating the array or collection. The following conditions must all be true; otherwise, an exception is thrown:
The starting index must be greater than or equal to Array::GetLowerBound for the dimension of the array that you want to iterate, or greater than or equal to 0 for a collection.
The ending index cannot exceed Array::GetUpperBound for the dimension of the array that you want to iterate, or cannot be greater than or equal to the Count property of a collection.
The following equation must be true for the dimension of the array that you want to iterate:
start_index >= lower_bound And start_index + items_to_iterate – 1 <= upper_bound
For a collection, the following equation must be true:
start_index >= 0 And start_index + items_to_iterate <= Count
The starting index of an array or collection can never be a negative number.
Assuming that an array must be zero-based. Arrays that are not zero-based can be created by the Array::CreateInstance(Type, array<Int32>, array<Int32>) method and can be returned by COM interop, although they aren’t CLS-compliant. The following example illustrates the that is thrown when you try to iterate a non-zero-based array created by the Array::CreateInstance(Type, array<Int32>, array<Int32>) method.
To correct the error, as the following example does, you can call the GetLowerBound method instead of making assumptions about the starting index of an array.
Confusing an index and the value at that index in a numeric array or collection. This issue usually occurs when using the foreach statement (in C#) or the For Each statement (in Visual Basic). The following example illustrates the problem.
The iteration construct returns each value in an array or collection, not its index. To eliminate the exception, use this code.
Providing an invalid column name to the DataView::Sort property.
Violating thread safety. Operations such as reading from the same StreamReader object, writing to the same StreamWriter object from multiple threads, or enumerating the objects in a Hashtable from different threads can throw an if the object isn’t accessed in a thread-safe way. This exception is typically intermittent because it relies on a race condition.
For a list of initial property values for an instance of , see the constructors.
The following intermediate language (IL) instructions throw :
uses the HRESULT COR_E_INDEXOUTOFRANGE, which has the value 0x80131508.
.NET FrameworkSupported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
.NET for Windows Phone appsSupported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8
Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.