OfficeIMO

API Reference

Class

ReaderPathDocumentResult

Namespace OfficeIMO.Reader
Assembly OfficeIMO.Reader
Modifiers sealed

Detailed document-oriented read result for a single file or a folder path.

Inheritance

  • Object
  • ReaderPathDocumentResult

Constructors

public ReaderPathDocumentResult() #

Properties

public IReadOnlyList<String> Files { get; set; } #

Source file paths included in the result.

public IReadOnlyList<ReaderSourceDocument> Documents { get; set; } #

Source-level documents returned for the path.

public Int32 FilesScanned { get; set; } #

Files considered for ingestion (allowed extension scope).

public Int32 FilesParsed { get; set; } #

Files parsed successfully.

public Int32 FilesSkipped { get; set; } #

Files skipped.

public Int64 BytesRead { get; set; } #

Bytes accepted for parsed files.

public Int32 ChunksProduced { get; set; } #

Total chunks produced before any returned-chunk shaping.

public Int32 ChunksReturned { get; set; } #

Total chunk objects materialized in Documents.

public Int32 TokenEstimateReturned { get; set; } #

Aggregated token estimate across returned chunks.

public Boolean Truncated { get; set; } #

True when returned chunk materialization was truncated by caller limits.

public IReadOnlyList<String> Warnings { get; set; } #

Aggregated warnings associated with the read.