Table of Contents

Class RvtExitCodes

Namespace
RvtIO
Assembly
RvtIO.dll

Process exit codes of the command line exporter (documented in the README and in docs/export-report.md).

public static class RvtExitCodes

Inheritance

Inherited Members

Fields

DecodeError

The container is readable but a decoder failed on its content (damaged or unsupported data). The report holds the exception.

public const int DecodeError = 4

Field Value

int

InputError

The input cannot be read: missing, empty, not a compound file, or cut or damaged so that a stream ends early.

public const int InputError = 2

Field Value

int

LimitExceeded

A stream exceeded a limit of the reader and the read was cut. Not returned with --allow-partial, except for a stream over the platform array length, which cannot be read at all.

public const int LimitExceeded = 3

Field Value

int

PartialRead

With --strict, the read finished without exceeding a limit, or --allow-partial accepted a limit, but the read is partial (a member failed to decode, was rebuilt by structural recovery, or decoded without a matching checksum, or the element table decoded no row). Nothing is exported; the report lists the streams and the reason.

public const int PartialRead = 6

Field Value

int

Success

The export finished. With --allow-partial, or without --strict when a stream lost or recovered a member, it may have read less than the whole file: the report says so.

public const int Success = 0

Field Value

int

Usage

The command line is wrong. Unchanged from earlier versions.

public const int Usage = 1

Field Value

int

Methods

ForRead(RvtReadDiagnostics, bool)

The exit code of a finished read: RvtIO.RvtExitCodes.LimitExceeded when a limit cut a stream and partial output was not allowed, else RvtIO.RvtExitCodes.Success.

public static int ForRead(RvtReadDiagnostics diagnostics, bool allowPartial)

Parameters

diagnostics RvtReadDiagnostics
allowPartial bool

Returns

int

ForRead(RvtReadDiagnostics, bool, bool, bool)

The exit code of a finished read: RvtIO.RvtExitCodes.LimitExceeded when a limit cut a stream and partial output was not allowed, else RvtIO.RvtExitCodes.PartialRead when strict is true and the read is partial, else RvtIO.RvtExitCodes.Success.

public static int ForRead(RvtReadDiagnostics diagnostics, bool allowPartial, bool strict, bool partialRead = false)

Parameters

diagnostics RvtReadDiagnostics
allowPartial bool
strict bool
partialRead bool

Returns

int