API Reference

Cmdlet

Get-OfficePdfPreflight

Namespace PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.Pdf.PdfDocumentPreflight

Reports whether OfficeIMO.Pdf can read or rewrite a PDF safely.

Remarks

Reports whether OfficeIMO.Pdf can read or rewrite a PDF safely.

Examples

Authored help example

Preflight a PDF before migration operations.

PS>


$preflight = Get-OfficePdfPreflight -Path .\Examples\Documents\Report.pdf
            $preflight.HasReadBlockers
            $preflight.HasRewriteBlockers
        

Checks whether OfficeIMO.Pdf can read or rewrite the PDF safely.

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-OfficePdfPreflight [-Password <String>] -Path <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Password String optionalposition: namedpipeline: False
Password used to preflight a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath
PDF file path.

Outputs

OfficeIMO.Pdf.PdfDocumentPreflight