Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
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

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Reader, Document Extraction, and OCR Guide

    Detect formats and extract normalized documents, chunks, hierarchy, tables, visuals, assets, OCR text, and ingest results. Includes examples and cmdlet links.

Examples

Authored help example

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.