Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsPdfAConversion.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsPdfAConversion.h
4 *
5 * Description: Sub Header file for Pdftools SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 *****************************************************************************/
13
14#ifndef PDFTOOLS_PDFTOOLSPDFACONVERSION_H__
15#define PDFTOOLS_PDFTOOLSPDFACONVERSION_H__
16
17#ifndef PDFTOOLS_CALL
18#if defined(WIN32)
19#define PDFTOOLS_CALL __stdcall
20#else
21#define PDFTOOLS_CALL
22#endif
23#endif
24
25#include "PdfTools_Types.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#define TPdfToolsPdfAConversion_Converter_ConversionEvent TPdfToolsPdfAConversion_Converter_ConversionEventW
35#define PdfToolsPdfAConversion_Converter_AddConversionEventHandler \
36 PdfToolsPdfAConversion_Converter_AddConversionEventHandlerW
37#define PdfToolsPdfAConversion_Converter_RemoveConversionEventHandler \
38 PdfToolsPdfAConversion_Converter_RemoveConversionEventHandlerW
39
40#else
41#define TPdfToolsPdfAConversion_Converter_ConversionEvent TPdfToolsPdfAConversion_Converter_ConversionEventA
42#define PdfToolsPdfAConversion_Converter_AddConversionEventHandler \
43 PdfToolsPdfAConversion_Converter_AddConversionEventHandlerA
44#define PdfToolsPdfAConversion_Converter_RemoveConversionEventHandler \
45 PdfToolsPdfAConversion_Converter_RemoveConversionEventHandlerA
46
47#endif
48
111 void* pContext, const char* szDataPart, const char* szMessage, TPdfToolsPdfAConversion_EventSeverity iSeverity,
112 TPdfToolsPdfAConversion_EventCategory iCategory, TPdfToolsPdfAConversion_EventCode iCode, const char* szContext,
113 int iPageNo);
176 void* pContext, const WCHAR* szDataPart, const WCHAR* szMessage, TPdfToolsPdfAConversion_EventSeverity iSeverity,
178 int iPageNo);
179
180/******************************************************************************
181 * Converter
182 *****************************************************************************/
196 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
211 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
226 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
241 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
243
254
320 TPdfToolsPdf_Document* pDocument, const TPdfToolsSys_StreamDescriptor* pOutStreamDesc,
322
323/******************************************************************************
324 * ConversionOptions
325 *****************************************************************************/
337
394 TPdfToolsPdfAConversion_ConversionOptions* pConversionOptions, const TPdfToolsPdf_Conformance* pConformance);
432 TPdfToolsPdfAConversion_ConversionOptions* pConversionOptions, BOOL bCopyMetadata);
433
434#ifdef __cplusplus
435}
436#endif
437
438#endif /* PDFTOOLS_PDFTOOLSPDFACONVERSION_H__ */
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_Converter_AddConversionEventHandlerW(TPdfToolsPdfAConversion_Converter *pConverter, void *pContext, TPdfToolsPdfAConversion_Converter_ConversionEventW pFunction)
Adds event handler.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_Converter_RemoveConversionEventHandlerW(TPdfToolsPdfAConversion_Converter *pConverter, void *pContext, TPdfToolsPdfAConversion_Converter_ConversionEventW pFunction)
Removes event handler.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_ConversionOptions_GetCopyMetadata(TPdfToolsPdfAConversion_ConversionOptions *pConversionOptions)
Whether to copy metadata Copy document information dictionary and XMP metadata. Default: TRUE.
PDFTOOLS_EXPORT TPdfToolsPdfAConversion_Converter *PDFTOOLS_CALL PdfToolsPdfAConversion_Converter_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_ConversionOptions_SetCopyMetadata(TPdfToolsPdfAConversion_ConversionOptions *pConversionOptions, BOOL bCopyMetadata)
Whether to copy metadata Copy document information dictionary and XMP metadata. Default: TRUE.
void(PDFTOOLS_CALL * TPdfToolsPdfAConversion_Converter_ConversionEventW)(void *pContext, const WCHAR *szDataPart, const WCHAR *szMessage, TPdfToolsPdfAConversion_EventSeverity iSeverity, TPdfToolsPdfAConversion_EventCategory iCategory, TPdfToolsPdfAConversion_EventCode iCode, const WCHAR *szContext, int iPageNo)
The event for errors, warnings, and informational messages that occur during conversion.
Definition PdfTools_PdfToolsPdfAConversion.h:175
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_Converter_RemoveConversionEventHandlerA(TPdfToolsPdfAConversion_Converter *pConverter, void *pContext, TPdfToolsPdfAConversion_Converter_ConversionEventA pFunction)
Removes event handler.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsPdfAConversion_Converter_Convert(TPdfToolsPdfAConversion_Converter *pConverter, TPdfToolsPdfAValidation_AnalysisResult *pAnalysis, TPdfToolsPdf_Document *pDocument, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsPdfAConversion_ConversionOptions *pOptions, TPdfToolsPdf_OutputOptions *pOutOptions)
Convert a document to PDF/A. Note that it is highly recommended to use TPdfToolsPdfAConversion_Conver...
void(PDFTOOLS_CALL * TPdfToolsPdfAConversion_Converter_ConversionEventA)(void *pContext, const char *szDataPart, const char *szMessage, TPdfToolsPdfAConversion_EventSeverity iSeverity, TPdfToolsPdfAConversion_EventCategory iCategory, TPdfToolsPdfAConversion_EventCode iCode, const char *szContext, int iPageNo)
The event for errors, warnings, and informational messages that occur during conversion.
Definition PdfTools_PdfToolsPdfAConversion.h:110
PDFTOOLS_EXPORT TPdfToolsPdfAConversion_ConversionOptions *PDFTOOLS_CALL PdfToolsPdfAConversion_ConversionOptions_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_ConversionOptions_SetConformance(TPdfToolsPdfAConversion_ConversionOptions *pConversionOptions, const TPdfToolsPdf_Conformance *pConformance)
The minimal target conformance.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_Converter_AddConversionEventHandlerA(TPdfToolsPdfAConversion_Converter *pConverter, void *pContext, TPdfToolsPdfAConversion_Converter_ConversionEventA pFunction)
Adds event handler.
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsPdfAConversion.h:21
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdfAConversion_ConversionOptions_GetConformance(TPdfToolsPdfAConversion_ConversionOptions *pConversionOptions, TPdfToolsPdf_Conformance *pConformance)
The minimal target conformance.
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:138
unsigned short WCHAR
Definition PdfTools_Platform.h:90
TPdfToolsPdfAConversion_EventCategory
The category of conversion events See TPdfToolsPdfAConversion_Converter_ConversionEvent for more info...
Definition PdfTools_Types.h:702
struct TPdfToolsPdfAConversion_ConversionOptions TPdfToolsPdfAConversion_ConversionOptions
The PDF/A conversion options The options for the conversion of documents using the converter's method...
Definition PdfTools_Types.h:2754
TPdfToolsPdf_Conformance
Definition PdfTools_Types.h:193
struct TPdfToolsPdfAConversion_Converter TPdfToolsPdfAConversion_Converter
The class to convert PDF documents to PDF/A.
Definition PdfTools_Types.h:2747
struct TPdfToolsPdf_OutputOptions TPdfToolsPdf_OutputOptions
The parameters for document-level features of output PDFs Output options are used in many operations ...
Definition PdfTools_Types.h:2217
TPdfToolsPdfAConversion_EventSeverity
The severity of conversion events See TPdfToolsPdfAConversion_Converter_ConversionEvent for more info...
Definition PdfTools_Types.h:647
struct TPdfToolsPdfAValidation_AnalysisResult TPdfToolsPdfAValidation_AnalysisResult
The PDF/A analysis result.
Definition PdfTools_Types.h:2743
#define BOOL
Definition PdfTools_Types.h:18
TPdfToolsPdfAConversion_EventCode
The code identifying particular conversion events See TPdfToolsPdfAConversion_Converter_ConversionEve...
Definition PdfTools_Types.h:965
struct TPdfToolsPdf_Document TPdfToolsPdf_Document
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
Definition PdfTools_Types.h:2224
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:44