SavePreflightReport
Compliance, Document inspection
Description
Создает текстовый отчет предварительной проверки с помощью CreatePreflightReport и записывает его в текстовый файл UTF-8; выходной каталог создается автоматически, если он еще не существует
Syntax
Delphi
Function TPDFlib.SavePreflightReport(Const InputFileName, Password, ReportFileName: WideString; ComplianceTests, Options: Integer): Integer;
Parameters
| InputFileName | Полный путь к проверяемому файлу PDF |
|---|---|
| Password | Пароль, используемый для открытия файла; передайте пустую строку для незашифрованных документов |
| ReportFileName | Путь к текстовому отчету назначения; родительские каталоги создаются автоматически; передача пустого значения возвращает 0 |
| ComplianceTests | Битовая маска, выбирающая включаемые тесты: 1 для PDF/A, 2 для PDF/UA-1, 3 или 0 для обоих |
| Options | Битовые флаги, передаваемые каждому выбранному тесту на соответствие; передайте 1, чтобы останавливать каждый тест после первой проблемы |
Return values
| 0 | Имя файла отчета было пустым |
|---|---|
| 1 | Отчет был успешно сгенерирован и записан |
Remarks
Используйте SavePreflightReportEx, если вывод должен быть в формате JSON, HTML или CSV; ошибки открытия файлов, валидации или записи возникают как исключения из базовых путей работы с файлами и проверки соответствия; оборачивайте вызов при использовании в консольных утилитах или службах, которым требуются коды выхода на уровне процессов
Example
if PDF.SavePreflightReport('output.pdf', '', 'output-preflight.txt', 1 or 2, 0) = 1 then
WriteLn('Preflight report saved.');See also
Preflight Reports, SavePreflightReportEx, CreatePreflightReport, ComparePreflightReports, CheckFileCompliance, ReleaseStringList