ArgumentOutOfRangeException Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

Public Class ArgumentOutOfRangeException _
    Inherits ArgumentException
public class ArgumentOutOfRangeException : 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, Exception) Initializes a new instance of the ArgumentOutOfRangeException class with a specified error message and the exception that is the cause of this exception.
ArgumentOutOfRangeException(String, String) Initializes a new instance of the ArgumentOutOfRangeException class with a specified error message and the name of the parameter that causes this exception.
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

Name Description
ActualValue Gets the argument value that causes 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 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.)
ParamName Gets the name of the parameter that causes this exception. (Inherited from ArgumentException.)
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 frames on the call stack at the time the current exception was thrown. (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 the Object is reclaimed by garbage collection. (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 a hash function for a particular type. (Inherited from Object.)
GetType Gets the runtime type of the current instance. (Inherited from Exception.)
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

Remarks

ArgumentOutOfRangeException is thrown when a method is invoked and at least one of the arguments passed to the method is not nullNothingnullptra null reference (Nothing in Visual Basic) 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 nullNothingnullptra 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.

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 Example

   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim guest1 As Guest = New Guest("Ben", "Miller", 17)
      outputBlock.Text &= guest1.GuestInfo & vbCrLf
   End Sub

   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

End Module
using System;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      Guest guest1 = new Guest("Ben", "Miller", 17);
      outputBlock.Text += guest1.GuestInfo() + "\n";
   }
}

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

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

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.

See Also

Reference

System Namespace

Exception