Cmdlet

Get-OfficeExcelStreamingContract

Aliases: ExcelStreamingContract

Module PSWriteOffice

Aliases

ExcelStreamingContract

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

GetOfficeExcelStreamingContractCommand.cs:23 Edit on GitHub

Reports large-workbook streaming and direct-writer suitability.

Syntax

Get-OfficeExcelStreamingContract [-Path] <String> [<CommonParameters>]

Parameter set: Path

Get-OfficeExcelStreamingContract -Document <ExcelDocument> [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Choose the write path for a large export.

$contract = Get-OfficeExcelStreamingContract -Path .\LargeExport.xlsx
[pscustomobject]@{
    EstimatedCells = $contract.EstimatedCellCount
    DirectWriter   = $contract.HasDirectDataSetFastSaveState
    Recommendation = $contract.Recommendation
}

Reports whether the workbook is already using OfficeIMO direct tabular state and gives a size-based recommendation for future imports or exports.

Parameters

-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook document.

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.