API Reference

Cmdlet

Get-OfficePdfDiagnostic

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

Gets PDF diagnostics, stream statistics, feature markers, and read/rewrite blockers.

Remarks

Gets PDF diagnostics, stream statistics, feature markers, and read/rewrite blockers.

Examples

Authored help example

Inspect diagnostics for a PDF.

PS>


$diagnostic = Get-OfficePdfDiagnostic -Path .\Report.pdf
            $diagnostic.StreamTypeCounts
            $diagnostic.Findings
        

Returns an OfficeIMO.Pdf diagnostic report for migration and troubleshooting workflows.

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

Parameters

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

Outputs

OfficeIMO.Pdf.PdfDiagnosticReport