Get-OfficeDocumentBatch

Namespace PSWriteOffice

Inputs

System.String[]

Outputs

OfficeIMO.Reader.OfficeDocumentReadResult

Source

Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentBatchCommand.cs:16 Edit on GitHub

Reads a bounded set of documents asynchronously while retaining input order.

Remarks

Reads a bounded set of documents asynchronously while retaining input order.

Examples

Authored help example

Read documents with four operations in flight.

PS>


$batch = [OfficeIMO.Reader.ReaderBatchOptions]::new(); $batch.MaxDegreeOfParallelism = 4; Get-ChildItem .\Reports -File | Get-OfficeDocumentBatch -BatchOptions $batch

OfficeIMO.Reader bounds concurrency and returns results in pipeline input order.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-OfficeDocumentBatch [-BatchOptions <ReaderBatchOptions>] -Path <String[]> [-Reader <OfficeDocumentReader>] [-ReaderOptions <ReaderOptions>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

BatchOptions ReaderBatchOptions optionalposition: namedpipeline: False: Optional maximum document count and degree of parallelism.
Path String[] requiredposition: 0pipeline: True (ByValue, ByPropertyName)aliases: FilePath, FullName: Paths to read.
Reader OfficeDocumentReader optionalposition: namedpipeline: False: Optional immutable reader with caller-configured processors.
ReaderOptions ReaderOptions optionalposition: namedpipeline: False: Optional source-reading limits and format behavior.

Outputs

OfficeIMO.Reader.OfficeDocumentReadResult