ArgumentOutOfRangeException Class

May 11, 2014

The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.

System.Object
  System.Exception
    System.SystemException
      System.ArgumentException
        System.ArgumentOutOfRangeException

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public class ArgumentOutOfRangeException : ArgumentException

The ArgumentOutOfRangeException type exposes the following members.

  NameDescription
Public methodArgumentOutOfRangeException()Initializes a new instance of the ArgumentOutOfRangeException class.
Public methodArgumentOutOfRangeException(String)Initializes a new instance of the ArgumentOutOfRangeException class with the name of the parameter that causes this exception.
Public methodArgumentOutOfRangeException(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 methodArgumentOutOfRangeException(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.
Public methodArgumentOutOfRangeException(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

  NameDescription
Public propertyActualValueGets the argument value that causes this exception.
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyMessageGets 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.)
Public propertyParamNameGets the name of the parameter that causes this exception. (Inherited from ArgumentException.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top

ArgumentOutOfRangeException is thrown when a method is invoked and at least one of the arguments passed to the method is not null 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 null, 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.

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.


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);
   }
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft