Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfTools.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfTools.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_PDFTOOLS_H__
20#define PDFTOOLS_PDFTOOLS_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"
31#include "PdfTools_PdfToolsSys.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define PdfTools_GetLastErrorMessage PdfTools_GetLastErrorMessageW
40#define PdfTools_Sdk_Initialize PdfTools_Sdk_InitializeW
41#define PdfTools_Sdk_AddFontDirectory PdfTools_Sdk_AddFontDirectoryW
42
43#define PdfTools_Sdk_GetVersion PdfTools_Sdk_GetVersionW
44
45#define PdfTools_Sdk_SetProducerSuffix PdfTools_Sdk_SetProducerSuffixW
46#define PdfTools_Sdk_GetProducerFullName PdfTools_Sdk_GetProducerFullNameW
47
48#define PdfTools_Sdk_GetProxy PdfTools_Sdk_GetProxyW
49#define PdfTools_Sdk_SetProxy PdfTools_Sdk_SetProxyW
50#define PdfTools_Sdk_GetLicensingService PdfTools_Sdk_GetLicensingServiceW
51#define PdfTools_Sdk_SetLicensingService PdfTools_Sdk_SetLicensingServiceW
52
53#define PdfTools_StringList_Get PdfTools_StringList_GetW
54#define PdfTools_StringList_Add PdfTools_StringList_AddW
55
56#define PdfTools_MetadataDictionary_Get PdfTools_MetadataDictionary_GetW
57#define PdfTools_MetadataDictionary_GetKey PdfTools_MetadataDictionary_GetKeyW
58#define PdfTools_MetadataDictionary_GetValue PdfTools_MetadataDictionary_GetValueW
59#define PdfTools_MetadataDictionary_Set PdfTools_MetadataDictionary_SetW
60#define PdfTools_MetadataDictionary_SetValue PdfTools_MetadataDictionary_SetValueW
61
62#define PdfTools_HttpClientHandler_SetClientCertificate PdfTools_HttpClientHandler_SetClientCertificateW
63#define PdfTools_HttpClientHandler_SetClientCertificateAndKey PdfTools_HttpClientHandler_SetClientCertificateAndKeyW
64
65#else
66#define PdfTools_GetLastErrorMessage PdfTools_GetLastErrorMessageA
67#define PdfTools_Sdk_Initialize PdfTools_Sdk_InitializeA
68#define PdfTools_Sdk_AddFontDirectory PdfTools_Sdk_AddFontDirectoryA
69
70#define PdfTools_Sdk_GetVersion PdfTools_Sdk_GetVersionA
71
72#define PdfTools_Sdk_SetProducerSuffix PdfTools_Sdk_SetProducerSuffixA
73#define PdfTools_Sdk_GetProducerFullName PdfTools_Sdk_GetProducerFullNameA
74
75#define PdfTools_Sdk_GetProxy PdfTools_Sdk_GetProxyA
76#define PdfTools_Sdk_SetProxy PdfTools_Sdk_SetProxyA
77#define PdfTools_Sdk_GetLicensingService PdfTools_Sdk_GetLicensingServiceA
78#define PdfTools_Sdk_SetLicensingService PdfTools_Sdk_SetLicensingServiceA
79
80#define PdfTools_StringList_Get PdfTools_StringList_GetA
81#define PdfTools_StringList_Add PdfTools_StringList_AddA
82
83#define PdfTools_MetadataDictionary_Get PdfTools_MetadataDictionary_GetA
84#define PdfTools_MetadataDictionary_GetKey PdfTools_MetadataDictionary_GetKeyA
85#define PdfTools_MetadataDictionary_GetValue PdfTools_MetadataDictionary_GetValueA
86#define PdfTools_MetadataDictionary_Set PdfTools_MetadataDictionary_SetA
87#define PdfTools_MetadataDictionary_SetValue PdfTools_MetadataDictionary_SetValueA
88
89#define PdfTools_HttpClientHandler_SetClientCertificate PdfTools_HttpClientHandler_SetClientCertificateA
90#define PdfTools_HttpClientHandler_SetClientCertificateAndKey PdfTools_HttpClientHandler_SetClientCertificateAndKeyA
91
92#endif
93
94/******************************************************************************
95 * Library
96 *****************************************************************************/
97
104PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Initialize();
105
112PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Uninitialize();
113
121PDFTOOLS_EXPORT TPdfTools_ErrorCode PDFTOOLS_CALL PdfTools_GetLastError();
122
136PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_GetLastErrorMessageA(char* pBuffer, size_t nBufferSize);
137
151PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_GetLastErrorMessageW(WCHAR* pBuffer, size_t nBufferSize);
152
161PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_SetLastErrorA(TPdfTools_ErrorCode iErrorCode, const char* szErrorMessage);
162
171PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_SetLastErrorW(TPdfTools_ErrorCode iErrorCode, const WCHAR* szErrorMessage);
172
173/******************************************************************************
174 * Object
175 *****************************************************************************/
184PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Release(void* pObject);
185
193PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_AddRef(void* pObject);
194
205PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Equals(void* pObject, void* pOther);
206
216PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_GetHashCode(void* pObject);
217/******************************************************************************
218 * ConsumptionData
219 *****************************************************************************/
235PDFTOOLS_EXPORT int PDFTOOLS_CALL
236PdfTools_ConsumptionData_GetRemainingPages(TPdfTools_ConsumptionData* pConsumptionData);
252PDFTOOLS_EXPORT int PDFTOOLS_CALL
253PdfTools_ConsumptionData_GetOverconsumption(TPdfTools_ConsumptionData* pConsumptionData);
254
255/******************************************************************************
256 * LicenseInfo
257 *****************************************************************************/
272PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_LicenseInfo_IsValid(TPdfTools_LicenseInfo* pLicenseInfo);
288PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_LicenseInfo_GetExpirationDate(TPdfTools_LicenseInfo* pLicenseInfo,
289 TPdfToolsSys_Date* pExpirationDate);
305PDFTOOLS_EXPORT TPdfTools_ConsumptionData* PDFTOOLS_CALL
306PdfTools_LicenseInfo_GetConsumptionData(TPdfTools_LicenseInfo* pLicenseInfo);
307
308/******************************************************************************
309 * Sdk
310 *****************************************************************************/
338PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_InitializeA(const char* szLicense, const char* szProducerSuffix);
366PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_InitializeW(const WCHAR* szLicense, const WCHAR* szProducerSuffix);
382PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_AddFontDirectoryA(const char* szDirectory);
398PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_AddFontDirectoryW(const WCHAR* szDirectory);
399
415PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetVersionA(char* pBuffer, size_t nBufferSize);
431PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetVersionW(WCHAR* pBuffer, size_t nBufferSize);
446PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProducerSuffixA(const char* szProducerSuffix);
461PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProducerSuffixW(const WCHAR* szProducerSuffix);
479PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProducerFullNameA(char* pBuffer, size_t nBufferSize);
497PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProducerFullNameW(WCHAR* pBuffer, size_t nBufferSize);
534PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProxyA(char* pBuffer, size_t nBufferSize);
571PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProxyW(WCHAR* pBuffer, size_t nBufferSize);
602PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProxyA(const char* szProxy);
633PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProxyW(const WCHAR* szProxy);
645PDFTOOLS_EXPORT TPdfTools_HttpClientHandler* PDFTOOLS_CALL PdfTools_Sdk_GetHttpClientHandler(void);
663PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_GetUsageTracking(void);
682PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetUsageTracking(BOOL bUsageTracking);
718PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetLicensingServiceA(char* pBuffer, size_t nBufferSize);
754PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetLicensingServiceW(WCHAR* pBuffer, size_t nBufferSize);
786PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetLicensingServiceA(const char* szLicensingService);
818PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetLicensingServiceW(const WCHAR* szLicensingService);
833PDFTOOLS_EXPORT TPdfTools_LicenseInfo* PDFTOOLS_CALL PdfTools_Sdk_GetLicenseInfoSnapshot(void);
834
835/******************************************************************************
836 * StringList
837 *****************************************************************************/
846PDFTOOLS_EXPORT TPdfTools_StringList* PDFTOOLS_CALL PdfTools_StringList_New(void);
847
860PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_StringList_GetCount(TPdfTools_StringList* pStringList);
882PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_StringList_GetA(TPdfTools_StringList* pStringList, int iIndex,
883 char* pBuffer, size_t nBufferSize);
905PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_StringList_GetW(TPdfTools_StringList* pStringList, int iIndex,
906 WCHAR* pBuffer, size_t nBufferSize);
923PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_StringList_AddA(TPdfTools_StringList* pStringList, const char* szString);
940PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_StringList_AddW(TPdfTools_StringList* pStringList, const WCHAR* szString);
941
942/******************************************************************************
943 * MetadataDictionary
944 *****************************************************************************/
953PDFTOOLS_EXPORT TPdfTools_MetadataDictionary* PDFTOOLS_CALL PdfTools_MetadataDictionary_New(void);
954
967PDFTOOLS_EXPORT int PDFTOOLS_CALL
968PdfTools_MetadataDictionary_GetCount(TPdfTools_MetadataDictionary* pMetadataDictionary);
982PDFTOOLS_EXPORT int PDFTOOLS_CALL
983PdfTools_MetadataDictionary_GetSize(TPdfTools_MetadataDictionary* pMetadataDictionary);
1005PDFTOOLS_EXPORT int PDFTOOLS_CALL
1006PdfTools_MetadataDictionary_GetBegin(TPdfTools_MetadataDictionary* pMetadataDictionary);
1026PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetEnd(TPdfTools_MetadataDictionary* pMetadataDictionary);
1047PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetNext(TPdfTools_MetadataDictionary* pMetadataDictionary,
1048 int it);
1068PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetA(TPdfTools_MetadataDictionary* pMetadataDictionary,
1069 const char* szKey);
1089PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetW(TPdfTools_MetadataDictionary* pMetadataDictionary,
1090 const WCHAR* szKey);
1112PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetKeyA(
1113 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, char* pBuffer, size_t nBufferSize);
1135PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetKeyW(
1136 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, WCHAR* pBuffer, size_t nBufferSize);
1158PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetValueA(
1159 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, char* pBuffer, size_t nBufferSize);
1181PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetValueW(
1182 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, WCHAR* pBuffer, size_t nBufferSize);
1203PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetA(TPdfTools_MetadataDictionary* pMetadataDictionary,
1204 const char* szKey, const char* szValue);
1225PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetW(TPdfTools_MetadataDictionary* pMetadataDictionary,
1226 const WCHAR* szKey, const WCHAR* szValue);
1244PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1245PdfTools_MetadataDictionary_SetValueA(TPdfTools_MetadataDictionary* pMetadataDictionary, int it, const char* szValue);
1263PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1264PdfTools_MetadataDictionary_SetValueW(TPdfTools_MetadataDictionary* pMetadataDictionary, int it, const WCHAR* szValue);
1279PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_Clear(TPdfTools_MetadataDictionary* pMetadataDictionary);
1296PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_Remove(TPdfTools_MetadataDictionary* pMetadataDictionary,
1297 int it);
1298
1299/******************************************************************************
1300 * HttpClientHandler
1301 *****************************************************************************/
1313PDFTOOLS_EXPORT TPdfTools_HttpClientHandler* PDFTOOLS_CALL PdfTools_HttpClientHandler_New(void);
1314
1339PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1340PdfTools_HttpClientHandler_SetClientCertificateA(TPdfTools_HttpClientHandler* pHttpClientHandler,
1341 const TPdfToolsSys_StreamDescriptor* pArchive, const char* szPassword);
1366PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateW(
1367 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pArchive,
1368 const WCHAR* szPassword);
1394PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateAndKeyA(
1395 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pCert,
1396 const TPdfToolsSys_StreamDescriptor* pKey, const char* szPassword);
1422PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateAndKeyW(
1423 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pCert,
1424 const TPdfToolsSys_StreamDescriptor* pKey, const WCHAR* szPassword);
1446PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_AddTrustedCertificate(
1447 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pCert);
1448
1469PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1470PdfTools_HttpClientHandler_GetSslVerifyServerCertificate(TPdfTools_HttpClientHandler* pHttpClientHandler);
1491PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetSslVerifyServerCertificate(
1492 TPdfTools_HttpClientHandler* pHttpClientHandler, BOOL bSslVerifyServerCertificate);
1493
1494#ifdef __cplusplus
1495}
1496#endif
1497
1498#endif /* PDFTOOLS_PDFTOOLS_H__ */
PdfTools_Initialize
PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Initialize()
Initializes the library.
PdfTools_MetadataDictionary_GetA
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetA(TPdfTools_MetadataDictionary *pMetadataDictionary, const char *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...
PdfTools_MetadataDictionary_GetEnd
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetEnd(TPdfTools_MetadataDictionary *pMetadataDictionary)
Get the end position of the map.
PdfTools_Equals
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Equals(void *pObject, void *pOther)
Compare two native objects.
PdfTools_Sdk_GetVersionW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetVersionW(WCHAR *pBuffer, size_t nBufferSize)
The version of the SDK.
PdfTools_HttpClientHandler_SetClientCertificateAndKeyW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateAndKeyW(TPdfTools_HttpClientHandler *pHttpClientHandler, const TPdfToolsSys_StreamDescriptor *pCert, const TPdfToolsSys_StreamDescriptor *pKey, const WCHAR *szPassword)
Set the SSL/TLS client certificate and private key The file must contain the certificate and its priv...
PdfTools_Sdk_SetProducerSuffixW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProducerSuffixW(const WCHAR *szProducerSuffix)
The suffix for the producer Suffix that is appended to the producer string within metadata of PDF out...
PdfTools_HttpClientHandler_AddTrustedCertificate
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_AddTrustedCertificate(TPdfTools_HttpClientHandler *pHttpClientHandler, const TPdfToolsSys_StreamDescriptor *pCert)
Add a certificate to the trust store Add a certificate to the trust store of this HttpClientHandler i...
PdfTools_HttpClientHandler_SetClientCertificateAndKeyA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateAndKeyA(TPdfTools_HttpClientHandler *pHttpClientHandler, const TPdfToolsSys_StreamDescriptor *pCert, const TPdfToolsSys_StreamDescriptor *pKey, const char *szPassword)
Set the SSL/TLS client certificate and private key The file must contain the certificate and its priv...
PdfTools_Sdk_GetProducerFullNameW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProducerFullNameW(WCHAR *pBuffer, size_t nBufferSize)
The producer string that is set within the metadata of PDF output documents The producer string depen...
PdfTools_HttpClientHandler_New
PDFTOOLS_EXPORT TPdfTools_HttpClientHandler *PDFTOOLS_CALL PdfTools_HttpClientHandler_New(void)
PdfTools_HttpClientHandler_SetClientCertificateA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateA(TPdfTools_HttpClientHandler *pHttpClientHandler, const TPdfToolsSys_StreamDescriptor *pArchive, const char *szPassword)
Set the SSL/TLS client certificate as PFX (PKCS#12) archive The file must contain the certificate its...
PdfTools_Sdk_SetProxyW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProxyW(const WCHAR *szProxy)
Proxy to use for all communication to remote servers.
PdfTools_Sdk_GetHttpClientHandler
PDFTOOLS_EXPORT TPdfTools_HttpClientHandler *PDFTOOLS_CALL PdfTools_Sdk_GetHttpClientHandler(void)
The default handler for communication to remote servers This instance is used wherever there is no de...
PdfTools_Sdk_GetProxyW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProxyW(WCHAR *pBuffer, size_t nBufferSize)
Proxy to use for all communication to remote servers.
PdfTools_MetadataDictionary_GetValueA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetValueA(TPdfTools_MetadataDictionary *pMetadataDictionary, int it, char *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.
PdfTools_MetadataDictionary_GetW
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetW(TPdfTools_MetadataDictionary *pMetadataDictionary, const WCHAR *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...
PdfTools_Sdk_GetProducerFullNameA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProducerFullNameA(char *pBuffer, size_t nBufferSize)
The producer string that is set within the metadata of PDF output documents The producer string depen...
PdfTools_Release
PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Release(void *pObject)
Release object.
PdfTools_MetadataDictionary_New
PDFTOOLS_EXPORT TPdfTools_MetadataDictionary *PDFTOOLS_CALL PdfTools_MetadataDictionary_New(void)
PdfTools_Sdk_GetVersionA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetVersionA(char *pBuffer, size_t nBufferSize)
The version of the SDK.
PdfTools_GetHashCode
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_GetHashCode(void *pObject)
Get a hash code.
PdfTools_SetLastErrorW
PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_SetLastErrorW(TPdfTools_ErrorCode iErrorCode, const WCHAR *szErrorMessage)
Set last error code and error message.
PdfTools_MetadataDictionary_Remove
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_Remove(TPdfTools_MetadataDictionary *pMetadataDictionary, int it)
Remove the entry at a position in the map.
PdfTools_SetLastErrorA
PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_SetLastErrorA(TPdfTools_ErrorCode iErrorCode, const char *szErrorMessage)
Set last error code and error message.
PdfTools_StringList_GetA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_StringList_GetA(TPdfTools_StringList *pStringList, int iIndex, char *pBuffer, size_t nBufferSize)
Returns the element at the specified position in the given list.
PdfTools_StringList_AddA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_StringList_AddA(TPdfTools_StringList *pStringList, const char *szString)
Add an element to the end of the list.
PdfTools_MetadataDictionary_GetBegin
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetBegin(TPdfTools_MetadataDictionary *pMetadataDictionary)
Get the position of the first entry in the map.
PdfTools_GetLastError
PDFTOOLS_EXPORT TPdfTools_ErrorCode PDFTOOLS_CALL PdfTools_GetLastError()
Retrieves the last error code.
PdfTools_HttpClientHandler_SetSslVerifyServerCertificate
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetSslVerifyServerCertificate(TPdfTools_HttpClientHandler *pHttpClientHandler, BOOL bSslVerifyServerCertificate)
Verify the server certificate for SSL/TLS.
PdfTools_Sdk_AddFontDirectoryW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_AddFontDirectoryW(const WCHAR *szDirectory)
Add custom font directory.
PdfTools_MetadataDictionary_GetKeyW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetKeyW(TPdfTools_MetadataDictionary *pMetadataDictionary, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.
PdfTools_StringList_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_StringList_GetCount(TPdfTools_StringList *pStringList)
Get the number of elements in the list.
PdfTools_MetadataDictionary_Clear
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_Clear(TPdfTools_MetadataDictionary *pMetadataDictionary)
Remove all entries from the map.
PdfTools_StringList_GetW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_StringList_GetW(TPdfTools_StringList *pStringList, int iIndex, WCHAR *pBuffer, size_t nBufferSize)
Returns the element at the specified position in the given list.
PdfTools_MetadataDictionary_SetValueW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetValueW(TPdfTools_MetadataDictionary *pMetadataDictionary, int it, const WCHAR *szValue)
Set the value of the entry at a position in the map.
PdfTools_MetadataDictionary_SetW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetW(TPdfTools_MetadataDictionary *pMetadataDictionary, const WCHAR *szKey, const WCHAR *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...
PdfTools_Sdk_InitializeW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_InitializeW(const WCHAR *szLicense, const WCHAR *szProducerSuffix)
Initialize the product and the license key. Before calling any of the other functions of the SDK,...
PdfTools_LicenseInfo_GetConsumptionData
PDFTOOLS_EXPORT TPdfTools_ConsumptionData *PDFTOOLS_CALL PdfTools_LicenseInfo_GetConsumptionData(TPdfTools_LicenseInfo *pLicenseInfo)
PdfTools_Sdk_GetUsageTracking
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_GetUsageTracking(void)
Property denoting whether the usage tracking is enabled or disabled.
PdfTools_Sdk_SetLicensingServiceA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetLicensingServiceA(const char *szLicensingService)
Licensing service to use for all licensing requests.
PdfTools_Sdk_GetProxyA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProxyA(char *pBuffer, size_t nBufferSize)
Proxy to use for all communication to remote servers.
PdfTools_Sdk_GetLicenseInfoSnapshot
PDFTOOLS_EXPORT TPdfTools_LicenseInfo *PDFTOOLS_CALL PdfTools_Sdk_GetLicenseInfoSnapshot(void)
PdfTools_MetadataDictionary_GetKeyA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetKeyA(TPdfTools_MetadataDictionary *pMetadataDictionary, int it, char *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.
PdfTools_MetadataDictionary_GetValueW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetValueW(TPdfTools_MetadataDictionary *pMetadataDictionary, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.
PdfTools_MetadataDictionary_GetNext
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetNext(TPdfTools_MetadataDictionary *pMetadataDictionary, int it)
Get the position of the next entry in the map.
PdfTools_Uninitialize
PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Uninitialize()
Uninitializes the library.
PdfTools_MetadataDictionary_SetA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetA(TPdfTools_MetadataDictionary *pMetadataDictionary, const char *szKey, const char *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...
PdfTools_ConsumptionData_GetOverconsumption
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_ConsumptionData_GetOverconsumption(TPdfTools_ConsumptionData *pConsumptionData)
PdfTools_Sdk_GetLicensingServiceW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetLicensingServiceW(WCHAR *pBuffer, size_t nBufferSize)
Licensing service to use for all licensing requests.
PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition PdfTools_PdfTools.h:26
PdfTools_Sdk_SetLicensingServiceW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetLicensingServiceW(const WCHAR *szLicensingService)
Licensing service to use for all licensing requests.
PdfTools_ConsumptionData_GetRemainingPages
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_ConsumptionData_GetRemainingPages(TPdfTools_ConsumptionData *pConsumptionData)
PdfTools_HttpClientHandler_SetClientCertificateW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateW(TPdfTools_HttpClientHandler *pHttpClientHandler, const TPdfToolsSys_StreamDescriptor *pArchive, const WCHAR *szPassword)
Set the SSL/TLS client certificate as PFX (PKCS#12) archive The file must contain the certificate its...
PdfTools_MetadataDictionary_GetSize
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetSize(TPdfTools_MetadataDictionary *pMetadataDictionary)
The number of key-value pairs in the map.
PdfTools_LicenseInfo_GetExpirationDate
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_LicenseInfo_GetExpirationDate(TPdfTools_LicenseInfo *pLicenseInfo, TPdfToolsSys_Date *pExpirationDate)
PdfTools_Sdk_InitializeA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_InitializeA(const char *szLicense, const char *szProducerSuffix)
Initialize the product and the license key. Before calling any of the other functions of the SDK,...
PdfTools_GetLastErrorMessageA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_GetLastErrorMessageA(char *pBuffer, size_t nBufferSize)
Retrieves the last error message.
PdfTools_MetadataDictionary_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetCount(TPdfTools_MetadataDictionary *pMetadataDictionary)
The number of key-value pairs in the map.
PdfTools_StringList_AddW
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_StringList_AddW(TPdfTools_StringList *pStringList, const WCHAR *szString)
Add an element to the end of the list.
PdfTools_LicenseInfo_IsValid
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_LicenseInfo_IsValid(TPdfTools_LicenseInfo *pLicenseInfo)
PdfTools_Sdk_GetLicensingServiceA
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetLicensingServiceA(char *pBuffer, size_t nBufferSize)
Licensing service to use for all licensing requests.
PdfTools_StringList_New
PDFTOOLS_EXPORT TPdfTools_StringList *PDFTOOLS_CALL PdfTools_StringList_New(void)
PdfTools_Sdk_SetProxyA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProxyA(const char *szProxy)
Proxy to use for all communication to remote servers.
PdfTools_Sdk_SetUsageTracking
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetUsageTracking(BOOL bUsageTracking)
Property denoting whether the usage tracking is enabled or disabled.
PdfTools_GetLastErrorMessageW
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_GetLastErrorMessageW(WCHAR *pBuffer, size_t nBufferSize)
Retrieve last error message.
PdfTools_AddRef
PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_AddRef(void *pObject)
Increase reference count of object.
PdfTools_MetadataDictionary_SetValueA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetValueA(TPdfTools_MetadataDictionary *pMetadataDictionary, int it, const char *szValue)
Set the value of the entry at a position in the map.
PdfTools_Sdk_AddFontDirectoryA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_AddFontDirectoryA(const char *szDirectory)
Add custom font directory.
PdfTools_Sdk_SetProducerSuffixA
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProducerSuffixA(const char *szProducerSuffix)
The suffix for the producer Suffix that is appended to the producer string within metadata of PDF out...
PdfTools_HttpClientHandler_GetSslVerifyServerCertificate
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_GetSslVerifyServerCertificate(TPdfTools_HttpClientHandler *pHttpClientHandler)
Verify the server certificate for SSL/TLS.
PdfTools_PdfToolsSys.h
PDFTOOLS_EXPORT
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
WCHAR
unsigned short WCHAR
Definition PdfTools_Platform.h:95
PdfTools_Types.h
BOOL
#define BOOL
Definition PdfTools_Types.h:23
TPdfTools_ErrorCode
TPdfTools_ErrorCode
Definition PdfTools_Types.h:34
TPdfTools_ConsumptionData
TPdfTools_HttpClientHandler
The handler and options for communication to remote server.
TPdfTools_LicenseInfo
TPdfTools_MetadataDictionary
TPdfTools_StringList
TPdfToolsSys_Date
Definition PdfTools_Types.h:3398
TPdfToolsSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49
Generated by doxygen 1.10.0