Home Library Learn Downloads Support Community
Sign in | United States - English | |
1 out of 4 rated this helpful - Rate this topic

FormatException Class

.NET Framework 4

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

System.Object
  System.Exception
    System.SystemException
      System.FormatException
        System.IO.FileFormatException
        System.Net.CookieException
        System.Reflection.CustomAttributeFormatException
        System.UriFormatException

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
F#
VB
Copy 
[SerializableAttribute]
[ComVisibleAttribute(true)]
public class FormatException : SystemException

The FormatException type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library FormatException() Initializes a new instance of the FormatException class.
Public method Supported by the XNA Framework Supported by Portable Class Library 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 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
  Name Description
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected property Supported by the XNA Framework Supported by Portable Class Library HResult Gets 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 InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property Source Gets 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 StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library 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 Finalize Allows 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 GetBaseException When 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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData When 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 GetType Gets 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().
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Creates and returns a string representation of the current exception. (Inherited from Exception.)
Top
  Name Description
Protected event SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

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.

.NET Framework

Supported in: 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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
The error in documentation of FormatException
The documentation says about the format of the method's argument. But why FormatException is not inherited from ArgumentException in this case? Probably the documentation needs to be fixed as follows: "The exception that is thrown when the format of a data does not meet the specifications."
History