CreatePreflightReportEx

Compliance, Document inspection

Description

Cria um relatório preflight para um arquivo PDF externo e converte o relatório para o formato de saída solicitado; este é o companheiro com suporte a formatos para CreatePreflightReport, que sempre retorna o relatório em texto simples

Syntax

Delphi

Function TPDFlib.CreatePreflightReportEx(Const InputFileName, Password: WideString; ComplianceTests, Options, ReportFormat: Integer): WideString;

Parameters

InputFileName	Caminho completo do arquivo PDF a ser validado The file is opened read-only and is not modified.
Password	Senha usada para abrir o arquivo; passe uma string vazia para documentos não criptografados
ComplianceTests	Máscara de bits selecionando quais verificações incluir: `1` para PDF/A, `2` para PDF/UA-1, `3` ou `0` para ambos
Options	Sinalizadores de bits passados para cada verificação de conformidade selecionada; passe `1` para interromper cada verificação após o seu primeiro problema
ReportFormat	Seletor de formato de saída: 0 — texto simples; 1 — objeto JSON com campos de cabeçalho, seções por verificação, matrizes de problemas e campos de resumo; 2 — documento HTML independente contendo o relatório de texto com escape; 3 — linhas CSV com metadados, verificações selecionadas, códigos e mensagens de problemas e linhas de resumo finais

Return value

Retorna o relatório gerado no formato selecionado; valores desconhecidos de ReportFormat retornam para o formato de texto simples

Remarks

Os formatos JSON, HTML e CSV são gerados a partir do mesmo relatório de texto usado por CreatePreflightReport, de modo que o status de aprovação/reprovação e a contagem de problemas permaneçam consistentes em todos os formatos de relatório

O objeto JSON expõe campos de cabeçalho, uma matriz sections, matrizes de strings de problemas e um objeto summary. O formulário HTML é um documento autônomo que escapa o relatório de texto dentro de um bloco pré-formatado. O formulário CSV usa colunas fixas kind,section,status,code,message e separa metadados, status de verificação, linhas de problemas e linhas de resumo para análise em planilhas ou CI

Para o contrato completo do formato de relatório e exemplos de linha de comando de demonstração, consulte Preflight Reports

Example

JsonReport := PDF.CreatePreflightReportEx('output.pdf', '', 1 or 2, 0, 1);
HtmlReport := PDF.CreatePreflightReportEx('output.pdf', '', 1 or 2, 0, 2);
CsvReport := PDF.CreatePreflightReportEx('output.pdf', '', 1 or 2, 0, 3);