FormatException Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of the FormatException class.
Overloads
| FormatException() |
Initializes a new instance of the FormatException class. |
| FormatException(String) |
Initializes a new instance of the FormatException class with a specified error message. |
| FormatException(SerializationInfo, StreamingContext) |
Obsolete.
Initializes a new instance of the FormatException class with serialized data. |
| 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. |
FormatException()
- Source:
- FormatException.cs
- Source:
- FormatException.cs
- Source:
- FormatException.cs
Initializes a new instance of the FormatException class.
public:
FormatException();public FormatException ();Public Sub New ()Remarks
This constructor initializes the Message property of the new instance to a system-supplied message that describes the error, such as "Invalid format." This message takes into account the current system culture.
The following table shows the initial property values for an instance of FormatException.
| Property | Value |
|---|---|
| InnerException | A null reference (Nothing in Visual Basic). |
| Message | The localized error message string. |
Applies to
FormatException(String)
- Source:
- FormatException.cs
- Source:
- FormatException.cs
- Source:
- FormatException.cs
Initializes a new instance of the FormatException class with a specified error message.
public:
FormatException(System::String ^ message);public FormatException (string message);public FormatException (string? message);new FormatException : string -> FormatExceptionPublic Sub New (message As String)Parameters
- message
- String
The message that describes the error.
Remarks
This constructor initializes the Exception.Message property of the new exception using the message parameter. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
The following table shows the initial property values for an instance of FormatException.
| Property | Value |
|---|---|
| InnerException | A null reference (Nothing in Visual Basic). |
| Message | The error message string. |
Applies to
FormatException(SerializationInfo, StreamingContext)
- Source:
- FormatException.cs
- Source:
- FormatException.cs
- Source:
- FormatException.cs
Caution
This API supports obsolete formatter-based serialization. It should not be called or extended by application code.
Initializes a new instance of the FormatException class with serialized data.
protected:
FormatException(System::Runtime::Serialization::SerializationInfo ^ info, System::Runtime::Serialization::StreamingContext context);protected FormatException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);[System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
protected FormatException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);new FormatException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> FormatException[<System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
new FormatException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> FormatExceptionProtected Sub New (info As SerializationInfo, context As StreamingContext)Parameters
- info
- SerializationInfo
The object that holds the serialized object data.
- context
- StreamingContext
The contextual information about the source or destination.
- Attributes
Remarks
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream.
Applies to
FormatException(String, Exception)
- Source:
- FormatException.cs
- Source:
- FormatException.cs
- Source:
- FormatException.cs
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.
public:
FormatException(System::String ^ message, Exception ^ innerException);public FormatException (string message, Exception innerException);public FormatException (string? message, Exception? innerException);new FormatException : string * Exception -> FormatExceptionPublic Sub New (message As String, innerException As Exception)Parameters
- message
- String
The error message that explains the reason for the exception.
- innerException
- Exception
The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.
Remarks
An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the InnerException property. The InnerException property returns the same value that is passed into the constructor, or a null reference (Nothing in Visual Basic) if the InnerException property does not supply the inner exception value to the constructor.
The following table shows the initial property values for an instance of FormatException.
| Property | Value |
|---|---|
| InnerException | The inner exception reference. |
| Message | The error message string. |
