Skip to main content
.NET Framework Class Library
FormatException Class

The exception that is thrown when the format of an argument does not meet the parameter specifications of the invoked method.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
<[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_0_0_0%]> _
<[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_0_0_1%](True)> _
Public Class FormatException _
	Inherits [%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_1_0_0%]]
[[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_1_0_1%](true)]
public class FormatException : [%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_2_0_0%]]
[[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_2_0_1%](true)]
public ref class FormatException : public [%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_3_0_1%](true)>]
type FormatException =  
    class 
        inherit [%$TOPIC/b5s9cs7s_en-us_VS_110_2_0_3_0_2%] 
    end

The FormatException type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps FormatExceptionInitializes a new instance of the FormatException class.
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps FormatException(String)Initializes a new instance of the FormatException class with a specified error message.
Protected method FormatException(SerializationInfo, StreamingContext)Initializes a new instance of the FormatException class with serialized data.
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps FormatException(String, Exception)Initializes a new instance of the FormatException class with a specified error message and a reference to the inner exception that is the cause of this exception.
Top
Properties
  NameDescription
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps InnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps MessageGets a message that describes the current exception. (Inherited from Exception.)
Public property Supported by Portable Class Library Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps 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 Supported in .NET for Windows Store apps GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetObjectDataWhen overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps 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.


In .NET for Windows Store apps Windows 8, this member is inherited from Object GetType.
Protected method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps 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

FormatException is thrown when the format of an argument in a method invocation does not match the format of the corresponding formal parameter type. For example, if a method specifies a String parameter consisting of two digits with an embedded period, passing a corresponding string argument containing only two digits to that method would cause FormatException to be thrown.

FormatException uses the HRESULT COR_E_FORMAT, which has the value 0x80131537.

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

Version Information

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

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.

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.