ArgumentOutOfRangeException Constructor (String, Object, String)

  • Article

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

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)

Syntax

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

public ArgumentOutOfRangeException(
    string paramName,
    Object actualValue,
    string message
)

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.

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 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.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

See Also

Reference

ArgumentOutOfRangeException Class

ArgumentOutOfRangeException Overload

System Namespace