API Reference

Cmdlet

ConvertTo-OfficePdfSanitized

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Pdf.PdfSanitizationResult

Removes or quarantines active PDF content and embedded payloads with post-save proof.

Remarks

Removes or quarantines active PDF content and embedded payloads with post-save proof.

Examples

Authored help example

Sanitize a PDF and inspect what was removed.

PS>


$result = ConvertTo-OfficePdfSanitized -Path .\Input.pdf -OutputPath .\Safe.pdf
        

Writes the proven full-rewrite result and returns findings, mutation plan, and quarantine data.

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

ConvertTo-OfficePdfSanitized [-Options <PdfSanitizationOptions>] -OutputPath <String> -Path <String> [-ReadOptions <PdfReadOptions>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Options PdfSanitizationOptions optionalposition: namedpipeline: False
Allowed actions, URI schemes, embedded-file policy, and rich-media policy.
OutputPath String requiredposition: 1pipeline: False
Destination PDF path.
Path String requiredposition: 0pipeline: False
Source PDF path.
ReadOptions PdfReadOptions optionalposition: namedpipeline: False
Optional bounded PDF parsing and password settings.

Outputs

OfficeIMO.Pdf.PdfSanitizationResult