Skip to main content
.NET Framework Class Library
ArgumentException Class

The exception that is thrown when one of the arguments provided to a method is not valid.

Inheritance Hierarchy
SystemObject
   SystemException
     SystemSystemException
      SystemArgumentException
        More...

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

The ArgumentException type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library ArgumentExceptionInitializes a new instance of the ArgumentException class.
Public method Supported by the XNA Framework Supported by Portable Class Library ArgumentException(String)Initializes a new instance of the ArgumentException class with a specified error message.
Protected method ArgumentException(SerializationInfo, StreamingContext)Initializes a new instance of the ArgumentException class with serialized data.
Public method Supported by the XNA Framework Supported by Portable Class Library ArgumentException(String, Exception)Initializes a new instance of the ArgumentException class with a specified error message and a reference to the inner exception that is the cause of this exception.
Public method Supported by the XNA Framework Supported by Portable Class Library ArgumentException(String, String)Initializes a new instance of the ArgumentException class with a specified error message and the name of the parameter that causes this exception.
Public method Supported by Portable Class Library ArgumentException(String, String, Exception)Initializes a new instance of the ArgumentException class with a specified error message, the parameter name, and a reference to the inner exception that is the cause of this exception.
Top
Properties
  NameDescription
Public property Supported by Portable Class Library 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 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 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 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 parameter name, or only the error message if no parameter name is set. (Overrides ExceptionMessage.)

In XNA Framework 3.0, this member is inherited from Exception Message.
Public property Supported by Portable Class Library ParamNameGets the name of the parameter that causes this exception.
Public property Supported by Portable Class Library 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 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 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 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 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 GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetObjectDataSets the SerializationInfo object with the parameter name and additional exception information. (Overrides ExceptionGetObjectData(SerializationInfo, StreamingContext).)
Public method Supported by the XNA Framework Supported by Portable Class Library 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.
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library 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

ArgumentException is thrown when a method is invoked and at least one of the passed arguments does not meet the parameter specification of the called method. The ParamName property identifies the invalid argument.

Most commonly, an ArgumentException is thrown by the common language runtime or another class library and indicates developer error. If you throw an ArgumentException from your code, you should ensure that the exception's Message property includes a meaningful error message that describes the invalid argument and the expected range of values for the argument.

The primary derived classes of ArgumentException are ArgumentNullException and ArgumentOutOfRangeException. These derived classes should be used instead of ArgumentException, except in situations where neither of the derived classes is acceptable. For example, exceptions should be thrown by:

  • ArgumentNullException whenever is passed to a method that does not accept it as a valid argument.

  • ArgumentOutOfRangeException when the value of an argument is outside the range of acceptable values; for example, when the value "46" is passed as the month argument during the creation of a DateTime.

If the method call does not have any argument or if the failure does not involve the arguments themselves, then InvalidOperationException should be used.

ArgumentException uses the HRESULT COR_E_ARGUMENT, which has the value 0x80070057.

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

Examples

The following example demonstrates how to throw and catch an ArgumentException.

Public Class App
    Public Shared Sub Main()
        ' ArgumentException is not thrown because 10 is an even number.
        Console.WriteLine("10 divided by 2 is {0}", DivideByTwo(10))
        Try  
            ' ArgumentException is thrown because 7 is not an even number.
            Console.WriteLine("7 divided by 2 is {0}", DivideByTwo(7))
        Catch Ex As ArgumentException
            ' Show the user that 7 cannot be divided by 2.
            Console.WriteLine("7 is not divided by 2 integrally.")
        End Try 
    End Sub 

    Private Shared Function DivideByTwo(ByVal num As Integer) As Integer 
        ' If num is an odd number, throw an ArgumentException. 
        If ((num And 1)  _
                    = 1) Then 
            Throw New ArgumentException("Number must be even", "num")
        End If 
        Return (num / 2)
    End Function 
End Class 
' This code produces the following output. 
'  
' 10 divided by 2 is 5 
' 7 is not divided by 2 integrally.
using System;

public sealed class App 
{
    static void Main() 
    {
        // ArgumentException is not thrown because 10 is an even number.
        Console.WriteLine("10 divided by 2 is {0}", DivideByTwo(10));
        try 
        {
             // ArgumentException is thrown because 7 is not an even number.
             Console.WriteLine("7 divided by 2 is {0}", DivideByTwo(7));
        }
        catch (ArgumentException)
        {
            // Show the user that 7 cannot be divided by 2.
            Console.WriteLine("7 is not divided by 2 integrally.");
        }
    }

    static int DivideByTwo(int num) 
    {
        // If num is an odd number, throw an ArgumentException. 
        if ((num & 1) == 1)
            throw new ArgumentException("Number must be even", "num");

        // num is even, return half of its value. 
        return num / 2;
    }
}


// This code produces the following output. 
//  
// 10 divided by 2 is 5 
// 7 is not divided by 2 integrally.
using namespace System;

int DivideByTwo(int num)
{
    // If num is an odd number, throw an ArgumentException. 
    if ((num & 1) == 1)
    {
        throw gcnew ArgumentException("Number must be even", "num");
    }
    // num is even, return half of its value. 
    return num / 2;
}

int main()
{
    // ArgumentException is not thrown because 10 is an even number.
    Console::WriteLine("10 divided by 2 is {0}", DivideByTwo(10));
    try
    {
        // ArgumentException is thrown because 7 is not an even number.
        Console::WriteLine("7 divided by 2 is {0}", DivideByTwo(7));
    }
    catch (ArgumentException^)
    {
        // Show the user that 7 cannot be divided by 2.
        Console::WriteLine("7 is not divided by 2 integrally.");
    }
}

// This code produces the following output. 
// 
// 10 divided by 2 is 5 
// 7 is not divided by 2 integrally.
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
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.