The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
Assembly: mscorlib (in mscorlib.dll)
Initializes a new instance of theclass.
Initializes a new instance of theclass with serialized data.
Initializes a new instance of theclass with the name of the parameter that causes this exception.
Initializes a new instance of theclass with a specified error message and the exception that is the cause of this exception.
|ArgumentOutOfRangeException(String^, Object^, String^)|
Initializes a new instance of theclass with the parameter name, the value of the argument, and a specified error message.
Initializes a new instance of theclass with the name of the parameter that causes this exception and a specified error message.
Gets the argument value that causes this exception.
Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)
Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)
Gets the error message and the string representation of the invalid argument value, or only the error message if the argument value is null.(Overrides ArgumentException::Message.)
Gets the name of the parameter that causes this exception.(Inherited from ArgumentException.)
Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)
Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)
Gets the method that throws the current exception.(Inherited from Exception.)
Determines whether the specified object is equal to the current object.(Inherited from Object.)
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
Serves as the default hash function. (Inherited from Object.)
Sets the SerializationInfo object with the invalid argument value and additional exception information.(Overrides ArgumentException::GetObjectData(SerializationInfo^, StreamingContext).)
Gets the runtime type of the current instance.(Inherited from Exception.)
Creates and returns a string representation of the current exception.(Inherited from Exception.)
Typically, anresults from developer error. Instead of handling the exception in a try/catch block, you should eliminate the cause of the exception or, if the argument is returned by a method call or input by the user before being passed to the method that throws the exception, you should validate arguments before passing them to the method.
is used extensively by:
The Array class.
String manipulation methods in the String class.
The conditions in which anexception is thrown include the following:
- You are retrieving the member of a collection by its index number, and the index number is invalid.
This is the most common cause of anexception. Typically, the index number is invalid for one of three reasons:
The collection has no members, and your code assumes that it does. The following example attempts to retrieve the first element of a collection that has no elements:
To prevent the exception, check whether the collection's Count property is greater than zero before attempting to retrieve any members, as the following code fragment does.
In some cases, this may occur because you are attempting to add a member to a collection by using an index that does not exist, rather than by calling the method, such as Add, that exists for this purpose. The following example attempts to add an element to a collection by using a non-existent index rather than calling the List<T>::Add method.
The following code fragment corrects this error:
You're attempting to retrieve an item whose index is negative. This usually occurs because you've searched a collection for the index of a particular element and have erroneously assumed that the search is successful. In the following example, the call to the List<T>::FindIndex(Predicate<T>^) method fails to find a string equal to "Z" and so returns -1. However, this is an invalid index value.
To prevent the exception, check that the search is successful by making sure that the returned index is greater than or equal to zero before attempting to retrieve the item from the collection, as the following code fragment does.
You're attempting to retrieve an element whose index is equal to the value of the collection's Count property, as the following example illustrates.
Because collections in the .NET Framework use zero-based indexing, the first element of the collection is at index 0, and the last element is at index Count - 1. You can eliminate the error by ensuring that you access the last element at index Count - 1, as the following code does.
- You are attempting to perform a string operation by calling a string manipulation method, and the starting index does not exist in the string.
Overloads of methods such as such as String::Compare, String::CompareOrdinal, String::IndexOf, IndexOfAny, String::Insert, String::LastIndexOf, String::LastIndexOfAny, Remove, or String::Substring that allow you to specify the starting index of the operation require that the index be a valid position within the string. Valid indexes range from 0 to String::Length - 1.
There are four common causes of thisexception:
You are working with an empty string., or String::Empty. Because its String::Length property returns 0, any attempt to manipulate it by index throws an exception. The following example, defines a GetFirstCharacter method that returns the first character of a string. If the string is empty, as the final string passed to the method is, the method throws an exception.
You can eliminate the exception by testing whether the string's String::Length is greater than zero or by calling the IsNullOrEmpty method to ensure that the string is not null or empty. The following code fragment does the latter. In this case, if the string is null or empty, the GetFirstCharacter method returns U+0000.
You're manipulating a string based on the position of a substring within that string, and you've failed to determine whether the substring was actually found.
The following example extracts the second word of a two-word phrase. It throws an String::IndexOf(String^) method returns -1 to indicate that the search failed, and this invalid value is then passed to the String::Substring(Int32) method.exception if the phrase consists of only one word, and therefore does not contain an embedded space character. This occurs because the call to the
To eliminate the exception, validate the value returned by the string search method before calling the string manipulation method.
- You've attempted to extract a substring that is outside the range of the current string.
The methods that extract substrings all require that you specify the starting position of the substring and, for substrings that do not continue to the end of the string, the number of characters in the substring. Note that this is not the index of the last character in the substring.
An String::IndexOf to identify the starting and ending positions of a substring:exception is typically thrown in this case because you've incorrectly calculated the number of characters in the substring. If you are using a search method like
If the character in the ending position returned by String::IndexOf is to be included in the substring, the ending position of the substring is given by the formula
endIndex - startIndex + 1
If the character in the ending position returned by String::IndexOf is to be excluded from the substring, the ending position of the substring is given by the formula
endIndex - startIndex
The following example defines a FindWords method that uses the String::IndexOfAny(array<Char>^, Int32) method to identify space characters and punctuation marks in a string and returns an array that contains the words found in the string.
- You have passed a negative number to a method with an argument that requires only positive numbers and zero, or you have passed either a negative number or zero to a method with an argument that requires only positive numbers.
For example, the Array::CreateInstance(Type^, Int32, Int32, Int32) method requires that you specify the number of elements in each dimension of a two-dimensional array; valid values for each dimension can range from 0 to Int32::MaxValue. But because the dimension argument in the following example has a negative value, the method throws an exception.
To correct the error, ensure that the value of the invalid argument is non-negative. You can do this by providing a valid value, as the following code fragment does.
You can also validate the input and, if it is invalid, take some action. The following code fragment displays an error message instead of calling the method.
- A race condition exists in an app that is multithreaded or has tasks that execute asynchronously and that updates an array or collection.
The following example uses a List<T> object to populate a collection of Continent objects. It throws an exception if the example attempts to display the seven items in the collection before the collection is fully populated.
In this case, two resources are accessed from multiple threads:
The continents collection. Its List<T>::Add method is called from multiple threads. In addition, the main or primary thread assumes the collection is fully populated with seven elements when it iterates its members.
The msg string, which is concatenated from multiple threads.
To correct the error, ensure that shared state is accessed in a thread-safe way, as follows.
if your app uses an array or collection object, consider using a thread-safe collection class, such as the types in the System.Collections.Concurrent namespace or the System.Collections.Immutable out-of-band release.
Ensure that shared state (that is, resources that can be accessed by multiple threads) is accessed in a thread-safe way, so that only one thread at a time has exclusive access to the resources. A large number of classes, such as CountdownEvent, Interlocked, Monitor, and Mutex, are available to synchronize access to resources. For more information, see Managed Threading. In addition, language support is available through the lock statement in C# and the SyncLock construct in Visual Basic.
The following example addresses the List<T> object with a ConcurrentBag<T> object to ensure that access to the collection is thread-safe, uses a CountdownEvent object to ensure that the application thread continues only after other threads have executed, and uses a lock to ensure that only one thread can access the msg variable at a time.exception and the other issues from the previous example. It replaces the
uses the HRESULT COR_E_ARGUMENTOUTOFRANGE, which has the value 0x80131502.
For a list of initial property values for an instance of, see the constructors.
Available since 8
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 8.1
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.