ArgumentOutOfRangeException Constructor (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.

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

new : 
        paramName:string * 
        actualValue:Object * 
        message:string -> ArgumentOutOfRangeException

Parameters

paramName
Type: System.String

The name of the parameter that caused the exception.

actualValue
Type: System.Object

The value of the argument that causes this exception.

message
Type: System.String

The message that describes the error.

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 Framework class library. However, the ActualValue property is provided so that applications can use the available argument value.

The actualValue parameter contains an invalid value that is passed to the method and causes 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.

.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

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft