.NET Framework Class Library
ArgumentOutOfRangeException Class

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
SystemObject
   SystemException
     SystemSystemException
       SystemArgumentException
        SystemArgumentOutOfRangeException

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
<[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_0_0_0%]> _
<[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_0_0_1%](True)> _
Public Class ArgumentOutOfRangeException _
	Inherits [%$TOPIC/8xt94y6e_en-us_VS_110_2_0_0_0_2%] _
	Implements [%$TOPIC/8xt94y6e_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_1_0_0%]]
[[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_1_0_1%](true)]
public class ArgumentOutOfRangeException : [%$TOPIC/8xt94y6e_en-us_VS_110_2_0_1_0_2%], 
	[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_2_0_0%]]
[[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_2_0_1%](true)]
public ref class ArgumentOutOfRangeException : public [%$TOPIC/8xt94y6e_en-us_VS_110_2_0_2_0_2%], 
	[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/8xt94y6e_en-us_VS_110_2_0_3_0_1%](true)>]
type ArgumentOutOfRangeException =  
    class 
        inherit [%$TOPIC/8xt94y6e_en-us_VS_110_2_0_3_0_2%] 
        interface [%$TOPIC/8xt94y6e_en-us_VS_110_2_0_3_0_3%] 
    end

The ArgumentOutOfRangeException type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps ArgumentOutOfRangeExceptionInitializes a new instance of the ArgumentOutOfRangeException class.
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps ArgumentOutOfRangeException(String)Initializes a new instance of the ArgumentOutOfRangeException class with the name of the parameter that causes this exception.
Protected method ArgumentOutOfRangeException(SerializationInfo, StreamingContext)Initializes a new instance of the ArgumentOutOfRangeException class with serialized data.
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps ArgumentOutOfRangeException(String, Exception)Initializes a new instance of the ArgumentOutOfRangeException class with a specified error message and the exception that is the cause of this exception.
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps 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.
Public method Supported by Portable Class Library Supported in .NET for Windows Store apps ArgumentOutOfRangeException(String, Object, String)Initializes a new instance of the ArgumentOutOfRangeException class with the parameter name, the value of the argument, and a specified error message.
Top
Properties
  NameDescription
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps ActualValueGets the argument value that causes this exception.
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps DataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps HelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps HResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps InnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Supported by the XNA Framework MessageGets the error message and the string representation of the invalid argument value, or only the error message if the argument value is null. (Overrides ArgumentExceptionMessage.)

In XNA Framework 3.0, this member is inherited from Exception Message.
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps ParamNameGets the name of the parameter that causes this exception. (Inherited from ArgumentException.)
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps SourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps StackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top
Methods
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps GetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetObjectDataSets the SerializationInfo object with the invalid argument value and additional exception information. (Overrides ArgumentExceptionGetObjectData(SerializationInfo, StreamingContext).)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps GetTypeGets 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.
Protected method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps ToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top
Events
  NameDescription
Protected event SerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (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 and does not contain a valid value.

ArgumentOutOfRangeException is used extensively by:

ArgumentOutOfRangeException behaves identically to ArgumentException. It is provided so that application code can differentiate between exceptions caused by invalid arguments that are not , and exceptions caused by null arguments. For errors caused by null arguments, see ArgumentNullException.

ArgumentOutOfRangeException uses the HRESULT COR_E_ARGUMENTOUTOFRANGE, which has the value 0x80131502.

For a list of initial property values for an instance of ArgumentOutOfRangeException, see the ArgumentOutOfRangeException constructors.

Examples

The following example defines a class to contain information about an invited guest. If the guest is younger than 21, an ArgumentOutOfRangeException exception is thrown.

Module Module1
   Public Sub Main()
       Try 
           Dim guest1 As Guest = New Guest("Ben", "Miller", 17)
           Console.WriteLine(guest1.GuestInfo)
       Catch outOfRange As ArgumentOutOfRangeException
           Console.WriteLine("Error: {0}", outOfRange.Message)
       End Try 
   End Sub 
End Module 

Class Guest
    Private FirstName As String 
    Private LastName As String 
    Private Age As Integer 

    Public Sub New(ByVal fName As String, ByVal lName As String, ByVal age As Integer)
        MyBase.New()
        FirstName = fName
        LastName = lName
        If (age < 21) Then 
            Throw New ArgumentOutOfRangeException("age", "All guests must be 21-years-old or older.")
        Else
            age = age
        End If 
    End Sub 

    Public Function GuestInfo() As String 
        Dim gInfo As String = (FirstName + (" " _
                    + (Me.LastName + (", " + Me.Age.ToString))))
        Return gInfo
    End Function 
End Class
using System;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            Guest guest1 = new Guest("Ben", "Miller", 17);
            Console.WriteLine(guest1.GuestInfo());
        }
        catch (ArgumentOutOfRangeException outOfRange)
        {

            Console.WriteLine("Error: {0}", outOfRange.Message);
        }
    }
}

class Guest
{
    private string FirstName;
    private string LastName;
    private int Age;

    public Guest(string fName, string lName, int age)
    {
        FirstName = fName;
        LastName = lName;
        if (age < 21)
            throw new ArgumentOutOfRangeException("age","All guests must be 21-years-old or older.");
        else
            Age = age;
    }

    public string GuestInfo()
    {
        string gInfo = FirstName + " " + LastName + ", " + Age.ToString();
        return(gInfo);
    }
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
Platforms

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.

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.