Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeOutputResult<TReport>

OfficeIMO

Namespace
OfficeIMO
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Pairs output status with the typed fidelity evidence from a document conversion.

Inheritance

  • object
  • OfficeOutputResult<TReport>

Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Type Parameters

TReport
Format-specific conversion report.

Methods

public static OfficeOutputResult<TReport> FromFailure(string? outputPath, Exception exception, TReport? report = null) #

Creates a failed output result, preserving any report completed before the failure.

Parameters

outputPath string? required
exception System.Exception required
report TReport? = null optional
public static OfficeOutputResult<TReport> FromSuccess(string? outputPath, TReport report) #

Creates a successful output result after the native writer has completed.

Parameters

outputPath string? required
report TReport required
public OfficeOutputResult<TReport> RequireSuccess() #

Returns this result after verifying that an artifact was written successfully.

public void ThrowIfLoss() #

Requires successful output and conversion evidence without reported loss.

Properties

public bool Succeeded { get; } #

Gets whether the operation completed successfully.

public string? OutputPath { get; } #

Destination path, or null for caller-owned streams.

public Exception? Exception { get; } #

Captured output failure, or null when output succeeded.

public TReport? Report { get; } #

Conversion evidence produced before writing, when available.

public bool HasLoss { get; } #

Whether available conversion evidence reports possible content loss.