JsonException Class

  • Reference

Definition

Namespace:
System.Text.Json
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v8.0.5
Package:
System.Text.Json v9.0.0-rc.2.24473.5
Source:
JsonException.cs
Source:
JsonException.cs
Source:
JsonException.cs

Defines a custom exception object that is thrown when invalid JSON text is encountered, the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object.

public ref class JsonException : Exception
public class JsonException : Exception
[System.Serializable]
public class JsonException : Exception
type JsonException = class
    inherit Exception
[<System.Serializable>]
type JsonException = class
    inherit Exception
Public Class JsonException
Inherits Exception
Inheritance
Object
Exception
JsonException
Attributes
SerializableAttribute

Remarks

For more information, see How to write custom converters for JSON serialization.

Constructors

JsonException()

Initializes a new instance of the JsonException class.
JsonException(SerializationInfo, StreamingContext)
Obsolete.

Creates a new exception object with serialized data.
JsonException(String, Exception)

Initializes a new instance of the JsonException class, with a specified error message and a reference to the inner exception that is the cause of this exception.
JsonException(String, String, Nullable<Int64>, Nullable<Int64>, Exception)

Creates a new exception object to relay error information to the user that includes a specified inner exception.
JsonException(String, String, Nullable<Int64>, Nullable<Int64>)

Creates a new exception object to relay error information to the user.
JsonException(String)

Initializes a new instance of the JsonException class with a specified error message.

Properties

BytePositionInLine

Gets the zero-based number of bytes read within the current line before the exception.
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)
LineNumber

Gets the zero-based number of lines read before the exception.
Message

Gets a message that describes the current exception.
Path

Gets The path within the JSON where the exception was encountered.
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.

Sets the SerializationInfo with information about the 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)

Applies to