ArgumentOutOfRangeException Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
Inheritance Hierarchy
System. . :: . .Object
System. . :: . .Exception
System. . :: . .SystemException
System. . :: . .ArgumentException
System..::..ArgumentOutOfRangeException
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
<SerializableAttribute> _
Public Class ArgumentOutOfRangeException _
Inherits ArgumentException
[SerializableAttribute]
public class ArgumentOutOfRangeException : ArgumentException
[SerializableAttribute]
public ref class ArgumentOutOfRangeException : public ArgumentException
[<SerializableAttribute>]
type ArgumentOutOfRangeException =
class
inherit ArgumentException
end
public class ArgumentOutOfRangeException extends ArgumentException
The ArgumentOutOfRangeException type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ArgumentOutOfRangeException() () () () | Initializes a new instance of the ArgumentOutOfRangeException class. | |
ArgumentOutOfRangeException(String) | Initializes a new instance of the ArgumentOutOfRangeException class with the name of the parameter that causes this exception. | |
ArgumentOutOfRangeException(String, String) | Initializes a new instance of the ArgumentOutOfRangeException class with the name of the parameter that causes this exception and a specified error message. |
Top
Properties
Name | Description | |
---|---|---|
InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) | |
Message | Gets the error message and the parameter name, or only the error message if no parameter name is set. (Inherited from ArgumentException.) | |
ParamName | Gets the name of the parameter that causes this exception. (Inherited from ArgumentException.) | |
StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
Top
Methods
Name | Description | |
---|---|---|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
Top
Fields
Name | Description | |
---|---|---|
m_HResult | (Inherited from Exception.) |
Top
Remarks
ArgumentOutOfRangeException is thrown when a method is invoked and at least one of the arguments passed to the method is not null Nothing nullptr unit a null reference (Nothing in Visual Basic) and does not contain a valid value.
ArgumentOutOfRangeException is used extensively by:
Classes in the System.Collections and System.IO namespaces.
The Array class.
ArgumentOutOfRangeException behaves identically to ArgumentException. It is provided so that application code can differentiate between exceptions caused by invalid arguments that are not null Nothing nullptr unit a null reference (Nothing in Visual Basic) , and exceptions caused by null arguments. For errors caused by null arguments, see ArgumentNullException.
For a list of initial property values for an instance of ArgumentOutOfRangeException, see the ArgumentOutOfRangeException constructors.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.