Get-OfficePdfCompliance

Namespace PSWriteOffice

Inputs

OfficeIMO.Pdf.PdfDocument System.String

Outputs

OfficeIMO.Pdf.PdfComplianceReadinessReport OfficeIMO.Pdf.PdfComplianceProofReport

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfComplianceCommand.cs:18 Edit on GitHub

Gets a generated PDF document compliance readiness report.

Remarks

Gets a generated PDF document compliance readiness report.

Examples

Authored help example

Check generated PDF compliance readiness.

PS>


$pdf = New-OfficePdf {
                Set-OfficePdfCompliance -Profile PdfA3B -Groundwork
                Add-OfficePdfHeading -Text 'Compliance readiness'
            } -NoSave
            $pdf | Get-OfficePdfCompliance -Profile PdfA3B

Returns the OfficeIMO.Pdf readiness report before saving.

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-OfficePdfCompliance [-Document <PdfDocument>] [-ExternalArguments <String>] [-ExternalDiagnostic <String>] [-ExternalExecutablePath <String>] [-ExternalExitCode <Nullable`1>] [-ExternalProfile <String>] [-ExternalStatus <NotRun|Passed|Failed|Error>] [-ExternalSuccessExitCode <Int32>] [-ExternalValidation <PdfExternalValidationResult[]>] [-ExternalValidator <VeraPdf|PdfUaValidator|Mustang|Custom>] [-ExternalValidatorName <String>] [-ExternalValidatorVersion <String>] -Profile <Nullable`1> [-Proof] [<CommonParameters>]

Parameter set: Document

Parameters

Document PdfDocument optionalposition: namedpipeline: True (ByValue): Generated PDF document to assess outside the DSL context.
ExternalArguments String optionalposition: namedpipeline: False: External validator command-line arguments recorded in the proof evidence.
ExternalDiagnostic String optionalposition: namedpipeline: False: Human-readable external validation diagnostic.
ExternalExecutablePath String optionalposition: namedpipeline: False: External validator executable path recorded in the proof evidence.
ExternalExitCode Nullable`1 optionalposition: namedpipeline: False: External validator process exit code. When provided, status is inferred from -ExternalSuccessExitCode.
ExternalProfile String optionalposition: namedpipeline: False: Profile string reported by the external validator, for example PDF/A-3b.
ExternalStatus PdfExternalValidationStatus optionalposition: namedpipeline: Falsevalues: 4: Unbound external validator status to attach when -ExternalValidator is provided.; Possible values: NotRun, Passed, Failed, Error
ExternalSuccessExitCode Int32 optionalposition: namedpipeline: False: External validator process exit code that means success.
ExternalValidation PdfExternalValidationResult[] optionalposition: namedpipeline: False: Artifact-bound results produced by the external validation lane. Use PdfExternalValidationResult.PassedForArtifact or FromExitCodeForArtifact with the exact validated bytes.
ExternalValidator PdfExternalValidatorKind[] optionalposition: namedpipeline: Falsevalues: 4: External validator families whose result should be attached to the proof report.; Possible values: VeraPdf, PdfUaValidator, Mustang, Custom
ExternalValidatorName String optionalposition: namedpipeline: False: Human-readable external validator name.
ExternalValidatorVersion String optionalposition: namedpipeline: False: External validator version recorded in the artifact-bound proof evidence.
Profile Nullable`1 requiredposition: namedpipeline: False: Compliance profile to assess. When omitted, the document's configured profile is used.
Proof SwitchParameter optionalposition: namedpipeline: False: Return a proof report that combines readiness with required external validator evidence placeholders.

Outputs

OfficeIMO.Pdf.PdfComplianceReadinessReport OfficeIMO.Pdf.PdfComplianceProofReport

Get-OfficePdfCompliance [-ExternalArguments <String>] [-ExternalDiagnostic <String>] [-ExternalExecutablePath <String>] [-ExternalExitCode <Nullable`1>] [-ExternalProfile <String>] [-ExternalStatus <NotRun|Passed|Failed|Error>] [-ExternalSuccessExitCode <Int32>] [-ExternalValidation <PdfExternalValidationResult[]>] [-ExternalValidator <VeraPdf|PdfUaValidator|Mustang|Custom>] [-ExternalValidatorName <String>] [-ExternalValidatorVersion <String>] [-Password <String>] -Path <String> -Profile <Nullable`1> [-Proof] [<CommonParameters>]

Parameter set: Path

Parameters

ExternalArguments String optionalposition: namedpipeline: False: External validator command-line arguments recorded in the proof evidence.
ExternalDiagnostic String optionalposition: namedpipeline: False: Human-readable external validation diagnostic.
ExternalExecutablePath String optionalposition: namedpipeline: False: External validator executable path recorded in the proof evidence.
ExternalExitCode Nullable`1 optionalposition: namedpipeline: False: External validator process exit code. When provided, status is inferred from -ExternalSuccessExitCode.
ExternalProfile String optionalposition: namedpipeline: False: Profile string reported by the external validator, for example PDF/A-3b.
ExternalStatus PdfExternalValidationStatus optionalposition: namedpipeline: Falsevalues: 4: Unbound external validator status to attach when -ExternalValidator is provided.; Possible values: NotRun, Passed, Failed, Error
ExternalSuccessExitCode Int32 optionalposition: namedpipeline: False: External validator process exit code that means success.
ExternalValidation PdfExternalValidationResult[] optionalposition: namedpipeline: False: Artifact-bound results produced by the external validation lane. Use PdfExternalValidationResult.PassedForArtifact or FromExitCodeForArtifact with the exact validated bytes.
ExternalValidator PdfExternalValidatorKind[] optionalposition: namedpipeline: Falsevalues: 4: External validator families whose result should be attached to the proof report.; Possible values: VeraPdf, PdfUaValidator, Mustang, Custom
ExternalValidatorName String optionalposition: namedpipeline: False: Human-readable external validator name.
ExternalValidatorVersion String optionalposition: namedpipeline: False: External validator version recorded in the artifact-bound proof evidence.
Password String optionalposition: namedpipeline: False: Password used to inspect a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByPropertyName)aliases: FilePath: Existing PDF file path to assess after generation.
Profile Nullable`1 requiredposition: namedpipeline: False: Compliance profile to assess. When omitted, the document's configured profile is used.
Proof SwitchParameter optionalposition: namedpipeline: False: Return a proof report that combines readiness with required external validator evidence placeholders.

Outputs

OfficeIMO.Pdf.PdfComplianceReadinessReport OfficeIMO.Pdf.PdfComplianceProofReport