Cmdlet

Get-OfficePdfImage

Module PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfExtractedImage System.IO.FileInfo

Source

GetOfficePdfImageCommand.cs:22 Edit on GitHub

Gets or extracts image resources from a PDF.

Syntax

Get-OfficePdfImage [-BaseName <String>] [-IgnorePermissionRestrictions] [-OutputDirectory <String>] [-PageRange <String>] [-Password <String>] [-Path] <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Extract images from selected pages.

$proof = @(
    Get-OfficePdfImage -Path .\Examples\Documents\Report.pdf -PageRange '1-2'
    Get-OfficePdfImage -Path .\Examples\Documents\Report.pdf -OutputDirectory .\Examples\Documents\PdfImages -BaseName 'report-image'
)
$proof

Returns image metadata or writes extracted images to disk.

Parameters

-BaseName String optional: Base file name used when extracting images to disk.
-IgnorePermissionRestrictions SwitchParameter optional: After successful password authentication, explicitly ignore owner-imposed extraction restrictions.
-OutputDirectory String optional: Optional directory where images should be written.
-PageRange String optional: Optional page ranges such as 1-3,5.
-Password String optional: Password used to authenticate an 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.