OverflowException Class

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

OverflowException.cs

The exception that is thrown when an arithmetic, casting, or conversion operation in a checked context results in an overflow.

public ref class OverflowException : ArithmeticException

public class OverflowException : ArithmeticException

type OverflowException = class
    inherit ArithmeticException

Public Class OverflowException
Inherits ArithmeticException

Inheritance

Object

Exception

SystemException

ArithmeticException

OverflowException

Remarks

An OverflowException is thrown at run time under the following conditions:

• An arithmetic operation produces a result that is outside the range of the data type returned by the operation. The following example illustrates the OverflowException that is thrown by a multiplication operation that overflows the bounds of the Int32 type.

  int value = 780000000;
  checked {
  try {
     // Square the original value.
     int square = value * value;
     Console.WriteLine("{0} ^ 2 = {1}", value, square);
  }
  catch (OverflowException) {
     double square = Math.Pow(value, 2);
     Console.WriteLine("Exception: {0} > {1:E}.",
                       square, Int32.MaxValue);
  } }
  // The example displays the following output:
  //       Exception: 6.084E+17 > 2.147484E+009.
  

  open Checked
  
  let v = 780000000
  try
     // Square the original value.
     let square = v * v
     printfn $"{v} ^ 2 = {square}"
  with :? OverflowException ->
      let square = float v ** 2
      printfn $"Exception: {square} > {Int32.MaxValue:E}."
  // The example displays the following output:
  //       Exception: 6.084E+17 > 2.147484E+009.
  

  Dim value As Integer = 780000000
  Try
     ' Square the original value.
     Dim square As Integer = value * value 
     Console.WriteLine("{0} ^ 2 = {1}", value, square)
  Catch e As OverflowException
     Dim square As Double = Math.Pow(value, 2)
     Console.WriteLine("Exception: {0} > {1:E}.", _
                       square, Int32.MaxValue)
  End Try
  ' The example displays the following output:
  '       Exception: 6.084E+17 > 2.147484E+009.
  

• A casting or conversion operation attempts to perform a narrowing conversion, and the value of the source data type is outside the range of the target data type. The following example illustrates the OverflowException that is thrown by the attempt to convert a large unsigned byte value to a signed byte value.

  byte value = 241;
  checked {
  try {
     sbyte newValue = (sbyte) value;
     Console.WriteLine("Converted the {0} value {1} to the {2} value {3}.",
                       value.GetType().Name, value,
                       newValue.GetType().Name, newValue);
  }
  catch (OverflowException) {
     Console.WriteLine("Exception: {0} > {1}.", value, SByte.MaxValue);
  } }
  // The example displays the following output:
  //       Exception: 241 > 127.
  

  open Checked
  
  let value = 241uy
  try
      let newValue = int8 value
      printfn $"Converted the {value.GetType().Name} value {value} to the {newValue.GetType().Name} value {newValue}."
  with :? OverflowException ->
      printfn $"Exception: {value} > {SByte.MaxValue}."
  // The example displays the following output:
  //       Exception: 241 > 127.
  

  Dim value As Byte = 241
  Try
     Dim newValue As SByte = (CSByte(value))
     Console.WriteLine("Converted the {0} value {1} to the {2} value {3}.", _
                       value.GetType().Name, value, _
                       newValue.GetType().Name, newValue)
  Catch e As OverflowException
     Console.WriteLine("Exception: {0} > {1}.", value, SByte.MaxValue)
  End Try                            
  ' The example displays the following output:
  '       Exception: 241 > 127.
  

In each case, the result of the operation is a value that is less than the MinValue property or greater than the MaxValue property of the data type that results from the operation.

For the arithmetic, casting, or conversion operation to throw an OverflowException, the operation must occur in a checked context. By default, arithmetic operations and overflows in Visual Basic are checked; in C# and F#, they are not. If the operation occurs in an unchecked context, the result is truncated by discarding any high-order bits that do not fit into the destination type. The following example illustrates such an unchecked conversion in C# or F#. It repeats the previous example in an unchecked context.

byte value = 241;
try {
   sbyte newValue = (sbyte) value;
   Console.WriteLine("Converted the {0} value {1} to the {2} value {3}.",
                     value.GetType().Name, value,
                     newValue.GetType().Name, newValue);
}
catch (OverflowException) {
   Console.WriteLine("Exception: {0} > {1}.", value, SByte.MaxValue);
}
// The example displays the following output:
//       Converted the Byte value 241 to the SByte value -15.

let value = 241uy
try
    let newValue = int8 value
    printfn $"Converted the {value.GetType().Name} value {value} to the {newValue.GetType().Name} value {newValue}."
with :? OverflowException ->
    printfn $"Exception: {value} > {SByte.MaxValue}."
// The example displays the following output:
//       Converted the Byte value 241 to the SByte value -15.

The following Microsoft intermediate language (MSIL) instructions throw an OverflowException:

• add.ovf. <signed>

• conv.ovf. <to type>

• conv.ovf. <to type> .un

• mul.ovf. <type>

• sub.ovf. <type>

• newarr

OverflowException uses the HRESULT COR_E_OVERFLOW, which has the value 0x80131516.

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

Constructors

OverflowException()	Initializes a new instance of the OverflowException class.
OverflowException(SerializationInfo, StreamingContext)	Obsolete. Initializes a new instance of the OverflowException class with serialized data.
OverflowException(String, Exception)	Initializes a new instance of the OverflowException class with a specified error message and a reference to the inner exception that is the cause of this exception.
OverflowException(String)	Initializes a new instance of the OverflowException class with a specified error message.

Properties

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
Message	Gets a message that describes the current exception. (Inherited from Exception)
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception)
GetType()	Gets the runtime type of the current instance. (Inherited from Exception)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Creates and returns a string representation of the current exception. (Inherited from Exception)

Events

SerializeObjectState

Obsolete. Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception)

See also

• Exception
• Handling and Throwing Exceptions