Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Get-OfficeDocumentBatch

Module
PSWriteOffice
Inputs
System.String[]
Outputs
OfficeIMO.Reader.OfficeDocumentReadResult
Source
GetOfficeDocumentBatchCommand.cs:19 Edit on GitHub

Reads supported files and folders with adjustable concurrency and limits.

Syntax

Get-OfficeDocumentBatch
[-AllStoreItems]
[-ContinueOnError]
[-Extension <String[]>]
[-IncludePageLocations]
[-MaxDegreeOfParallelism <Int32>]
[-MaxDocuments <Int32>]
[-MaxStoreItems <Int32>]
[-NoDocumentLimit]
[-Path] <String[]>
[-Recurse]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

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

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

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

Parameters

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

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.