API Reference

Class

ReaderBatchOptions

Namespace OfficeIMO.Reader

Assembly OfficeIMO.Reader.Core

Source ../../../../_/OfficeIMO.Reader.Core/ReaderBatchOptions.cs:20

Modifiers sealed

Bounds multi-document asynchronous Reader execution.

Inheritance

Object
ReaderBatchOptions

Usage

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

Accepted by parameters

Method OfficeDocumentReader.ReadDocumentsAsCompletedAsync parameter batchOptions
Method OfficeDocumentReader.ReadDocumentsAsync parameter batchOptions
Method OfficeDocumentReader.ReadDocumentsDetailedAsync parameter batchOptions

Constructors

public ReaderBatchOptions() #

../../../../_/OfficeIMO.Reader.Core/ReaderBatchOptions.cs:20

Inherited Methods

Properties

public Nullable<Int32> MaxDegreeOfParallelism { get; set; } #

../../../../_/OfficeIMO.Reader.Core/ReaderBatchOptions.cs:15

Maximum number of document reads in flight. Null uses the reader's configured limit.

public Int32 MaxDocuments { get; set; } #

../../../../_/OfficeIMO.Reader.Core/ReaderBatchOptions.cs:20

Maximum number of input documents accepted by one batch. Default: 500.