ArgumentOutOfRangeException Constructors

Reference

Definition

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of the ArgumentOutOfRangeException class.

Overloads

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(SerializationInfo, StreamingContext)	Obsolete. Initializes a new instance of the ArgumentOutOfRangeException class with serialized data.
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 the name of the parameter that causes this exception and a specified error message.
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.

ArgumentOutOfRangeException()

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Initializes a new instance of the ArgumentOutOfRangeException class.

public:
 ArgumentOutOfRangeException();

public ArgumentOutOfRangeException ();

Public Sub New ()

Remarks

This constructor initializes the Message property of the new instance to a system-supplied message that describes the error, such as "Nonnegative number required." This message takes into account the current system culture.

The following table shows the initial property values for an instance of ArgumentOutOfRangeException.

Property	Value
InnerException	A null reference (`Nothing` in Visual Basic).
Message	The localized error message string.

Applies to

ArgumentOutOfRangeException(String)

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Initializes a new instance of the ArgumentOutOfRangeException class with the name of the parameter that causes this exception.

public:
 ArgumentOutOfRangeException(System::String ^ paramName);

public ArgumentOutOfRangeException (string paramName);

public ArgumentOutOfRangeException (string? paramName);

new ArgumentOutOfRangeException : string -> ArgumentOutOfRangeException

Public Sub New (paramName As String)

Parameters

paramName: String

The name of the parameter that causes this exception.

Remarks

This constructor initializes the ParamName property of the new instance using the paramName parameter. The content of paramName is intended to be understood by humans.

The following table shows the initial property values for an instance of ArgumentOutOfRangeException.

Property	Value
InnerException	A null reference (`Nothing` in Visual Basic).
Message	The empty string ("").
ParamName	The parameter name string.

Applies to

ArgumentOutOfRangeException(SerializationInfo, StreamingContext)

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Caution

This API supports obsolete formatter-based serialization. It should not be called or extended by application code.

Initializes a new instance of the ArgumentOutOfRangeException class with serialized data.

protected:
 ArgumentOutOfRangeException(System::Runtime::Serialization::SerializationInfo ^ info, System::Runtime::Serialization::StreamingContext context);

protected ArgumentOutOfRangeException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);

[System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
protected ArgumentOutOfRangeException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);

new ArgumentOutOfRangeException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> ArgumentOutOfRangeException

[<System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
new ArgumentOutOfRangeException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> ArgumentOutOfRangeException

Protected Sub New (info As SerializationInfo, context As StreamingContext)

Parameters

info: SerializationInfo

The object that holds the serialized object data.

context: StreamingContext

An object that describes the source or destination of the serialized data.

Attributes: ObsoleteAttribute

Remarks

This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see XML and SOAP Serialization.

Applies to

ArgumentOutOfRangeException(String, Exception)

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Initializes a new instance of the ArgumentOutOfRangeException class with a specified error message and the exception that is the cause of this exception.

public:
 ArgumentOutOfRangeException(System::String ^ message, Exception ^ innerException);

public ArgumentOutOfRangeException (string message, Exception innerException);

public ArgumentOutOfRangeException (string? message, Exception? innerException);

new ArgumentOutOfRangeException : string * Exception -> ArgumentOutOfRangeException

Public Sub New (message As String, innerException As Exception)

Parameters

message: String

The error message that explains the reason for this exception.

innerException: Exception

The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.

Applies to

ArgumentOutOfRangeException(String, String)

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Initializes a new instance of the ArgumentOutOfRangeException class with the name of the parameter that causes this exception and a specified error message.

public:
 ArgumentOutOfRangeException(System::String ^ paramName, System::String ^ message);

public ArgumentOutOfRangeException (string paramName, string message);

public ArgumentOutOfRangeException (string? paramName, string? message);

new ArgumentOutOfRangeException : string * string -> ArgumentOutOfRangeException

Public Sub New (paramName As String, message As String)

Parameters

paramName: String

The name of the parameter that caused the exception.

message: String

The message that describes the error.

Remarks

This constructor initializes the Message property of the new instance using the value of the message parameter. The content of the message parameter is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

This constructor initializes the ParamName property of the new instance using the paramName parameter. The content of paramName is intended to be understood by humans.

The following table shows the initial property values for an instance of ArgumentOutOfRangeException.

Property	Value
InnerException	`null`.
Message	The error message string.
ParamName	The parameter name string.

Applies to

ArgumentOutOfRangeException(String, Object, String)

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Source:: ArgumentOutOfRangeException.cs

Initializes a new instance of the ArgumentOutOfRangeException class with the parameter name, the value of the argument, and a specified error message.

public:
 ArgumentOutOfRangeException(System::String ^ paramName, System::Object ^ actualValue, System::String ^ message);

public ArgumentOutOfRangeException (string paramName, object actualValue, string message);

public ArgumentOutOfRangeException (string? paramName, object? actualValue, string? message);

new ArgumentOutOfRangeException : string * obj * string -> ArgumentOutOfRangeException

Public Sub New (paramName As String, actualValue As Object, message As String)

Parameters

paramName: String

The name of the parameter that caused the exception.

actualValue: Object

The value of the argument that causes this exception.

message: String

The message that describes the error.

Remarks

This constructor initializes the ParamName property of the new instance using the paramName parameter, the ActualValue property using the actualValue parameter, and the Message property using the message parameter. The content of the paramName and message parameters is intended to be understood by humans. The caller of this constructor is required to ensure that these strings have been localized for the current system culture.

The actualValue parameter is not used within the .NET class library. However, apps can use the ActualValue property to obtain the available argument value.

The actualValue parameter contains the invalid value that was passed to the method and caused this exception to be thrown. This value is stored in the ActualValue property and its string representation is appended to the message string held in the Message property.

The following table shows the initial property values for an instance of ArgumentOutOfRangeException.

Property	Value
ActualValue	The argument value.
InnerException	The null reference (`Nothing` in Visual Basic).
Message	The error message string.
ParamName	The parameter name string.

Applies to

Share via

ArgumentOutOfRangeException Constructors

Definition

Overloads

ArgumentOutOfRangeException()

Remarks

Applies to

ArgumentOutOfRangeException(String)

Parameters

Remarks

Applies to

ArgumentOutOfRangeException(SerializationInfo, StreamingContext)

Parameters

Remarks

See also

Applies to

ArgumentOutOfRangeException(String, Exception)

Parameters

Applies to

ArgumentOutOfRangeException(String, String)

Parameters

Remarks

Applies to

ArgumentOutOfRangeException(String, Object, String)

Parameters

Remarks

Applies to

Additional resources