Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Get-OfficeDocumentIngest

Namespace PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.Reader.ReaderIngestResult
Source
Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentIngestCommand.cs:17 Edit on GitHub

Reads a folder into an OfficeIMO.Reader ingestion summary.

Remarks

Reads a folder into an OfficeIMO.Reader ingestion summary.

Examples

Authored help example

Ingest a report folder.

PS>


$ingest = Get-OfficeDocumentIngest -FolderPath .\Reports -Extension docx,pdf,rtf -MaxFiles 50
            $ingest.Files | Select-Object Path, Parsed, ChunksProduced

Reads supported files from a folder and returns the ingestion summary with per-file status and chunk counts.

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-OfficeDocumentIngest [-AllStoreItems] [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Extension <String[]>] -FolderPath <String> [-MaxChars <Int32>] [-MaxFiles <Int32>] [-MaxInputBytes <Int64>] [-MaxStoreItems <Int32>] [-MaxTableRows <Int32>] [-MaxTotalBytes <Int64>] [-NoChunks] [-NoExcelHeaders] [-NoHashes] [-NoMarkdownHeadingChunks] [-NoRecurse] [-OpenXmlMaxCharactersInPart <Int64>] [-Reader <OfficeDocumentReader>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AllStoreItems SwitchParameter optionalposition: namedpipeline: False
Project every matching item from each email store.
ExcelA1Range String optionalposition: namedpipeline: False
Optional Excel A1 range to read.
ExcelChunkRows Int32 optionalposition: namedpipeline: False
Excel rows per emitted worksheet chunk.
ExcelSheetName String optionalposition: namedpipeline: False
Optional Excel sheet name to read.
ExcludePowerPointNotes SwitchParameter optionalposition: namedpipeline: False
Exclude PowerPoint speaker notes.
ExcludeWordFootnotes SwitchParameter optionalposition: namedpipeline: False
Exclude Word footnotes.
Extension String[] optionalposition: namedpipeline: Falsealiases: Extensions
Allowed folder extensions such as .docx, .xlsx, .pdf, .html, or json.
FolderPath String requiredposition: 0pipeline: True (ByValue)
Folder path to ingest.
MaxChars Int32 optionalposition: namedpipeline: False
Maximum emitted chunk characters.
MaxFiles Int32 optionalposition: namedpipeline: False
Maximum number of folder files to read.
MaxInputBytes Int64 optionalposition: namedpipeline: False
Maximum input size in bytes.
MaxStoreItems Int32 optionalposition: namedpipeline: False
Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
MaxTableRows Int32 optionalposition: namedpipeline: False
Maximum table rows per emitted table chunk.
MaxTotalBytes Int64 optionalposition: namedpipeline: False
Maximum total folder bytes to read.
NoChunks SwitchParameter optionalposition: namedpipeline: False
Do not materialize chunks in the returned ingestion result.
NoExcelHeaders SwitchParameter optionalposition: namedpipeline: False
Treat the first Excel row as data instead of headers.
NoHashes SwitchParameter optionalposition: namedpipeline: False
Disable source and chunk hash computation.
NoMarkdownHeadingChunks SwitchParameter optionalposition: namedpipeline: False
Do not split Markdown by headings.
NoRecurse SwitchParameter optionalposition: namedpipeline: False
Do not recurse into child folders.
OpenXmlMaxCharactersInPart Int64 optionalposition: namedpipeline: False
OpenXML maximum characters per part.
Reader OfficeDocumentReader optionalposition: namedpipeline: False
Optional immutable OfficeIMO reader with caller-configured handlers and processors.

Outputs

OfficeIMO.Reader.ReaderIngestResult