Get Started

API Reference

Cmdlet

Get-OfficeDocumentBatch

Namespace PSWriteOffice
Inputs
System.String[]
Outputs
OfficeIMO.Reader.OfficeDocumentReadResult
Source
Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentBatchCommand.cs:19 Edit on GitHub

Reads supported files and folders with adjustable concurrency and limits.

Remarks

Reads supported files and folders with adjustable concurrency and limits.

Examples

Authored help example

Example 1: Read supported files below a folder with four reads in flight.

PS>


Get-OfficeDocumentBatch -Path .\Reports -Recurse -MaxDegreeOfParallelism 4 -ContinueOnError

PSWriteOffice discovers registered formats and reports individual read failures without requiring .NET option objects.

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 [-AllStoreItems] [-BatchOptions <ReaderBatchOptions>] [-ContinueOnError] [-Extension <String[]>] [-IncludePageLocations] [-MaxDegreeOfParallelism <Nullable`1>] [-MaxDocuments <Nullable`1>] [-MaxStoreItems <Nullable`1>] [-NoDocumentLimit] -Path <String[]> [-Reader <OfficeDocumentReader>] [-ReaderOptions <ReaderOptions>] [-Recurse] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AllStoreItems SwitchParameter optionalposition: namedpipeline: False
Project every matching item from each email store.
BatchOptions ReaderBatchOptions optionalposition: namedpipeline: False
Advanced batch settings supplied by a .NET host.
ContinueOnError SwitchParameter optionalposition: namedpipeline: False
Report individual read errors and continue processing other documents.
Extension String[] optionalposition: namedpipeline: Falsealiases: Extensions
Optional extensions to include. Registered Reader formats are used automatically when omitted.
IncludePageLocations SwitchParameter optionalposition: namedpipeline: False
Compute Word and RTF page locations when supported.
MaxDegreeOfParallelism Nullable`1 optionalposition: namedpipeline: False
Maximum document reads in flight.
MaxDocuments Nullable`1 optionalposition: namedpipeline: False
Maximum documents accepted in one batch. The default is 500.
MaxStoreItems Nullable`1 optionalposition: namedpipeline: False
Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
NoDocumentLimit SwitchParameter optionalposition: namedpipeline: False
Remove the document-count ceiling.
Path String[] requiredposition: 0pipeline: True (ByValue, ByPropertyName)aliases: FilePath, FullName
File, directory, or wildcard paths to read.
Reader OfficeDocumentReader optionalposition: namedpipeline: False
Advanced immutable Reader configured by a .NET host.
ReaderOptions ReaderOptions optionalposition: namedpipeline: False
Advanced source-reading settings supplied by a .NET host.
Recurse SwitchParameter optionalposition: namedpipeline: False
Search subdirectories when a path names a directory.

Outputs

OfficeIMO.Reader.OfficeDocumentReadResult