ImfFileException Class

Definition

Namespace: DataStandardizer.File.InternetMessage

Exception to normal processing of an Internet message.

Syntax

public sealed class ImfFileException : Exception

Remarks

Details of where the problem was found are held in Exception.Data, under the keys in DataItemName.

Constructors

Constructor Notes
ImfFileException() Creates an exception with a default message.
ImfFileException(string message) Creates an exception with a message.
ImfFileException(string message, Exception innerException) Creates an exception with a message and the exception that caused it.

ImfFileException.DataItemName Class

Keys of the items in Exception.Data.

Field Value Meaning
BytePosition BytePosition The 0-based offset, in bytes from the start of the data, at which the problem was found, as a Int64. Present only for a problem found by a reader.
DiagnosticKind DiagnosticKind The kind of problem, as an ImfDiagnosticKind. Present only for a problem that an option can turn into an ImfDiagnostic, found by an ImfReader, ImfWriter, ImfEntityReader, MboxReader, MboxWriter, EmlxReader or EmlxWriter.
EntityPath EntityPath The path of the entity in which the problem was found, as a String, in the form that ImfEntityEvent.EntityPath describes. Present only for a problem found by an ImfEntityReader or ImfEntityWriter, or by the conformance checks of an ImfReader or ImfWriter.
FieldName FieldName The name of the header field, as a String, which for a required field that is missing is the name it should have. Otherwise present only once the name has been read.
LineNumber LineNumber The 1-based number of the physical line on which the problem was found, as a Int64. Present only for a problem found by a reader.
MessageIndex MessageIndex The 0-based index of the message in an mbox file, as a Int64. Present only for a problem found by an MboxReader or MboxWriter, or by an ImfEntityReader that an MboxReader gave. In a problem with the format of the file, DataItemName.BytePosition and DataItemName.LineNumber count from the start of the file. In a problem in a message, they count from the start of the message as it reads after any quotes have been removed.

Applies to

Targets netstandard1.1, netstandard2.0, netstandard2.1, and net10.0. The nullable reference annotations apply to the netstandard2.1 and net10.0 builds.

See also


This site uses Just the Docs, a documentation theme for Jekyll.