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 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_PDFTOOLSPDFACONVERSION_H__
20#define PDFTOOLS_PDFTOOLSPDFACONVERSION_H__
21
22#ifndef PDFTOOLS_CALL
23#if defined(WIN32)
24#define PDFTOOLS_CALL __stdcall
25#else
26#define PDFTOOLS_CALL
27#endif
28#endif
29
30#include "PdfTools_Types.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define TPdfToolsPdfAConversion_Converter_ConversionEvent TPdfToolsPdfAConversion_Converter_ConversionEventW
40#define PdfToolsPdfAConversion_Converter_AddConversionEventHandler \
41 PdfToolsPdfAConversion_Converter_AddConversionEventHandlerW
42#define PdfToolsPdfAConversion_Converter_RemoveConversionEventHandler \
43 PdfToolsPdfAConversion_Converter_RemoveConversionEventHandlerW
44
45#else
46#define TPdfToolsPdfAConversion_Converter_ConversionEvent TPdfToolsPdfAConversion_Converter_ConversionEventA
47#define PdfToolsPdfAConversion_Converter_AddConversionEventHandler \
48 PdfToolsPdfAConversion_Converter_AddConversionEventHandlerA
49#define PdfToolsPdfAConversion_Converter_RemoveConversionEventHandler \
50 PdfToolsPdfAConversion_Converter_RemoveConversionEventHandlerA
51
52#endif
53
116 void* pContext, const char* szDataPart, const char* szMessage, TPdfToolsPdfAConversion_EventSeverity iSeverity,
117 TPdfToolsPdfAConversion_EventCategory iCategory, TPdfToolsPdfAConversion_EventCode iCode, const char* szContext,
118 int iPageNo);
181 void* pContext, const WCHAR* szDataPart, const WCHAR* szMessage, TPdfToolsPdfAConversion_EventSeverity iSeverity,
183 int iPageNo);
184
185/******************************************************************************
186 * Converter
187 *****************************************************************************/
201 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
216 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
231 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
246 TPdfToolsPdfAConversion_Converter* pConverter, void* pContext,
248
258
323 TPdfToolsPdf_Document* pDocument, const TPdfToolsSys_StreamDescriptor* pOutStreamDesc,
325
326/******************************************************************************
327 * ConversionOptions
328 *****************************************************************************/
339
396 TPdfToolsPdfAConversion_ConversionOptions* pConversionOptions, const TPdfToolsPdf_Conformance* pConformance);
434 TPdfToolsPdfAConversion_ConversionOptions* pConversionOptions, BOOL bCopyMetadata);
435
436#ifdef __cplusplus
437}
438#endif
439
440#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:180
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:115
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:26
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:143
unsigned short WCHAR
Definition PdfTools_Platform.h:95
TPdfToolsPdfAConversion_EventCategory
The category of conversion events See TPdfToolsPdfAConversion_Converter_ConversionEvent for more info...
Definition PdfTools_Types.h:707
TPdfToolsPdf_Conformance
Definition PdfTools_Types.h:198
TPdfToolsPdfAConversion_EventSeverity
The severity of conversion events See TPdfToolsPdfAConversion_Converter_ConversionEvent for more info...
Definition PdfTools_Types.h:652
#define BOOL
Definition PdfTools_Types.h:23
TPdfToolsPdfAConversion_EventCode
The code identifying particular conversion events See TPdfToolsPdfAConversion_Converter_ConversionEve...
Definition PdfTools_Types.h:970
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
The parameters for document-level features of output PDFs Output options are used in many operations ...
The PDF/A conversion options The options for the conversion of documents using the converter's method...
The class to convert PDF documents to PDF/A.
The PDF/A analysis result.
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49