Cmdlet

Get-OfficePdfOptimization

Module PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfOptimizationReport

Source

GetOfficePdfOptimizationCommand.cs:18 Edit on GitHub

Gets lossless PDF optimization opportunities without modifying the file.

Syntax

Get-OfficePdfOptimization [-IgnorePermissionRestrictions] [-Password <String>] [-Path] <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Review optimization candidates.

$report = Get-OfficePdfOptimization -Path .\Report.pdf
$report.EstimatedSavingsBytes
$report.DuplicateStreams

Returns stream and duplicate-object hints before any rewrite operation is attempted.

Parameters

-IgnorePermissionRestrictions SwitchParameter optional: After successful password authentication, explicitly ignore owner-imposed usage restrictions.
-Password String optional: Password used to analyze a Standard password-encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.

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.