Cmdlet

ConvertTo-OfficePdfSanitized

Module PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Pdf.PdfSanitizationResult

Source

ConvertToOfficePdfSanitizedCommand.cs:17 Edit on GitHub

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

Syntax

ConvertTo-OfficePdfSanitized [-IgnorePermissionRestrictions] [-Options <PdfSanitizationOptions>] [-OutputPath] <String> [-Password <String>] [-Path] <String> [-ReadOptions <PdfLoadOptions>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Sanitize a PDF and inspect what was removed.

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

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

Parameters

-IgnorePermissionRestrictions SwitchParameter optional: After successful password authentication, explicitly ignore owner-imposed modification restrictions.
-Options PdfSanitizationOptions optional: Allowed actions, URI schemes, embedded-file policy, and rich-media policy.
-OutputPath String requiredposition: 1: Destination PDF path.
-Password String optional: Password used to authenticate an encrypted PDF.
-Path String requiredposition: 0: Source PDF path.
-ReadOptions PdfLoadOptions optional: Optional bounded PDF parsing and password settings.

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.