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
42#define PdfTools_Sdk_GetVersion PdfTools_Sdk_GetVersionW
43
44#define PdfTools_Sdk_SetProducerSuffix PdfTools_Sdk_SetProducerSuffixW
45#define PdfTools_Sdk_GetProducerFullName PdfTools_Sdk_GetProducerFullNameW
46
47#define PdfTools_Sdk_GetProxy PdfTools_Sdk_GetProxyW
48#define PdfTools_Sdk_SetProxy PdfTools_Sdk_SetProxyW
49#define PdfTools_Sdk_GetLicensingService PdfTools_Sdk_GetLicensingServiceW
50#define PdfTools_Sdk_SetLicensingService PdfTools_Sdk_SetLicensingServiceW
51
52#define PdfTools_StringList_Get PdfTools_StringList_GetW
53#define PdfTools_StringList_Add PdfTools_StringList_AddW
54
55#define PdfTools_MetadataDictionary_Get PdfTools_MetadataDictionary_GetW
56#define PdfTools_MetadataDictionary_GetKey PdfTools_MetadataDictionary_GetKeyW
57#define PdfTools_MetadataDictionary_GetValue PdfTools_MetadataDictionary_GetValueW
58#define PdfTools_MetadataDictionary_Set PdfTools_MetadataDictionary_SetW
59#define PdfTools_MetadataDictionary_SetValue PdfTools_MetadataDictionary_SetValueW
60
61#define PdfTools_HttpClientHandler_SetClientCertificate PdfTools_HttpClientHandler_SetClientCertificateW
62#define PdfTools_HttpClientHandler_SetClientCertificateAndKey PdfTools_HttpClientHandler_SetClientCertificateAndKeyW
63
64#else
65#define PdfTools_GetLastErrorMessage PdfTools_GetLastErrorMessageA
66#define PdfTools_Sdk_Initialize PdfTools_Sdk_InitializeA
67
68#define PdfTools_Sdk_GetVersion PdfTools_Sdk_GetVersionA
69
70#define PdfTools_Sdk_SetProducerSuffix PdfTools_Sdk_SetProducerSuffixA
71#define PdfTools_Sdk_GetProducerFullName PdfTools_Sdk_GetProducerFullNameA
72
73#define PdfTools_Sdk_GetProxy PdfTools_Sdk_GetProxyA
74#define PdfTools_Sdk_SetProxy PdfTools_Sdk_SetProxyA
75#define PdfTools_Sdk_GetLicensingService PdfTools_Sdk_GetLicensingServiceA
76#define PdfTools_Sdk_SetLicensingService PdfTools_Sdk_SetLicensingServiceA
77
78#define PdfTools_StringList_Get PdfTools_StringList_GetA
79#define PdfTools_StringList_Add PdfTools_StringList_AddA
80
81#define PdfTools_MetadataDictionary_Get PdfTools_MetadataDictionary_GetA
82#define PdfTools_MetadataDictionary_GetKey PdfTools_MetadataDictionary_GetKeyA
83#define PdfTools_MetadataDictionary_GetValue PdfTools_MetadataDictionary_GetValueA
84#define PdfTools_MetadataDictionary_Set PdfTools_MetadataDictionary_SetA
85#define PdfTools_MetadataDictionary_SetValue PdfTools_MetadataDictionary_SetValueA
86
87#define PdfTools_HttpClientHandler_SetClientCertificate PdfTools_HttpClientHandler_SetClientCertificateA
88#define PdfTools_HttpClientHandler_SetClientCertificateAndKey PdfTools_HttpClientHandler_SetClientCertificateAndKeyA
89
90#endif
91
92/******************************************************************************
93 * Library
94 *****************************************************************************/
95
102PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Initialize();
103
110PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Uninitialize();
111
119PDFTOOLS_EXPORT TPdfTools_ErrorCode PDFTOOLS_CALL PdfTools_GetLastError();
120
134PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_GetLastErrorMessageA(char* pBuffer, size_t nBufferSize);
135
149PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_GetLastErrorMessageW(WCHAR* pBuffer, size_t nBufferSize);
150
159PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_SetLastErrorA(TPdfTools_ErrorCode iErrorCode, const char* szErrorMessage);
160
169PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_SetLastErrorW(TPdfTools_ErrorCode iErrorCode, const WCHAR* szErrorMessage);
170
171/******************************************************************************
172 * Object
173 *****************************************************************************/
182PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_Release(void* pObject);
183
191PDFTOOLS_EXPORT void PDFTOOLS_CALL PdfTools_AddRef(void* pObject);
192
203PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Equals(void* pObject, void* pOther);
204
214PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_GetHashCode(void* pObject);
215/******************************************************************************
216 * ConsumptionData
217 *****************************************************************************/
233PDFTOOLS_EXPORT int PDFTOOLS_CALL
234PdfTools_ConsumptionData_GetRemainingPages(TPdfTools_ConsumptionData* pConsumptionData);
250PDFTOOLS_EXPORT int PDFTOOLS_CALL
251PdfTools_ConsumptionData_GetOverconsumption(TPdfTools_ConsumptionData* pConsumptionData);
252
253/******************************************************************************
254 * LicenseInfo
255 *****************************************************************************/
270PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_LicenseInfo_IsValid(TPdfTools_LicenseInfo* pLicenseInfo);
286PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_LicenseInfo_GetExpirationDate(TPdfTools_LicenseInfo* pLicenseInfo,
287 TPdfToolsSys_Date* pExpirationDate);
303PDFTOOLS_EXPORT TPdfTools_ConsumptionData* PDFTOOLS_CALL
304PdfTools_LicenseInfo_GetConsumptionData(TPdfTools_LicenseInfo* pLicenseInfo);
305
306/******************************************************************************
307 * Sdk
308 *****************************************************************************/
336PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_InitializeA(const char* szLicense, const char* szProducerSuffix);
364PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_InitializeW(const WCHAR* szLicense, const WCHAR* szProducerSuffix);
365
381PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetVersionA(char* pBuffer, size_t nBufferSize);
397PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetVersionW(WCHAR* pBuffer, size_t nBufferSize);
412PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProducerSuffixA(const char* szProducerSuffix);
427PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProducerSuffixW(const WCHAR* szProducerSuffix);
445PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProducerFullNameA(char* pBuffer, size_t nBufferSize);
463PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProducerFullNameW(WCHAR* pBuffer, size_t nBufferSize);
500PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProxyA(char* pBuffer, size_t nBufferSize);
537PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetProxyW(WCHAR* pBuffer, size_t nBufferSize);
568PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProxyA(const char* szProxy);
599PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetProxyW(const WCHAR* szProxy);
611PDFTOOLS_EXPORT TPdfTools_HttpClientHandler* PDFTOOLS_CALL PdfTools_Sdk_GetHttpClientHandler(void);
629PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_GetUsageTracking(void);
648PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetUsageTracking(BOOL bUsageTracking);
684PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetLicensingServiceA(char* pBuffer, size_t nBufferSize);
720PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_Sdk_GetLicensingServiceW(WCHAR* pBuffer, size_t nBufferSize);
752PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetLicensingServiceA(const char* szLicensingService);
784PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_Sdk_SetLicensingServiceW(const WCHAR* szLicensingService);
799PDFTOOLS_EXPORT TPdfTools_LicenseInfo* PDFTOOLS_CALL PdfTools_Sdk_GetLicenseInfoSnapshot(void);
800
801/******************************************************************************
802 * StringList
803 *****************************************************************************/
812PDFTOOLS_EXPORT TPdfTools_StringList* PDFTOOLS_CALL PdfTools_StringList_New(void);
813
826PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_StringList_GetCount(TPdfTools_StringList* pStringList);
848PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_StringList_GetA(TPdfTools_StringList* pStringList, int iIndex,
849 char* pBuffer, size_t nBufferSize);
871PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_StringList_GetW(TPdfTools_StringList* pStringList, int iIndex,
872 WCHAR* pBuffer, size_t nBufferSize);
889PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_StringList_AddA(TPdfTools_StringList* pStringList, const char* szString);
906PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_StringList_AddW(TPdfTools_StringList* pStringList, const WCHAR* szString);
907
908/******************************************************************************
909 * MetadataDictionary
910 *****************************************************************************/
919PDFTOOLS_EXPORT TPdfTools_MetadataDictionary* PDFTOOLS_CALL PdfTools_MetadataDictionary_New(void);
920
933PDFTOOLS_EXPORT int PDFTOOLS_CALL
934PdfTools_MetadataDictionary_GetCount(TPdfTools_MetadataDictionary* pMetadataDictionary);
948PDFTOOLS_EXPORT int PDFTOOLS_CALL
949PdfTools_MetadataDictionary_GetSize(TPdfTools_MetadataDictionary* pMetadataDictionary);
971PDFTOOLS_EXPORT int PDFTOOLS_CALL
972PdfTools_MetadataDictionary_GetBegin(TPdfTools_MetadataDictionary* pMetadataDictionary);
992PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetEnd(TPdfTools_MetadataDictionary* pMetadataDictionary);
1013PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetNext(TPdfTools_MetadataDictionary* pMetadataDictionary,
1014 int it);
1034PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetA(TPdfTools_MetadataDictionary* pMetadataDictionary,
1035 const char* szKey);
1055PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfTools_MetadataDictionary_GetW(TPdfTools_MetadataDictionary* pMetadataDictionary,
1056 const WCHAR* szKey);
1078PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetKeyA(
1079 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, char* pBuffer, size_t nBufferSize);
1101PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetKeyW(
1102 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, WCHAR* pBuffer, size_t nBufferSize);
1124PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetValueA(
1125 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, char* pBuffer, size_t nBufferSize);
1147PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfTools_MetadataDictionary_GetValueW(
1148 TPdfTools_MetadataDictionary* pMetadataDictionary, int it, WCHAR* pBuffer, size_t nBufferSize);
1169PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetA(TPdfTools_MetadataDictionary* pMetadataDictionary,
1170 const char* szKey, const char* szValue);
1191PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_SetW(TPdfTools_MetadataDictionary* pMetadataDictionary,
1192 const WCHAR* szKey, const WCHAR* szValue);
1210PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1211PdfTools_MetadataDictionary_SetValueA(TPdfTools_MetadataDictionary* pMetadataDictionary, int it, const char* szValue);
1229PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1230PdfTools_MetadataDictionary_SetValueW(TPdfTools_MetadataDictionary* pMetadataDictionary, int it, const WCHAR* szValue);
1245PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_Clear(TPdfTools_MetadataDictionary* pMetadataDictionary);
1262PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_MetadataDictionary_Remove(TPdfTools_MetadataDictionary* pMetadataDictionary,
1263 int it);
1264
1265/******************************************************************************
1266 * HttpClientHandler
1267 *****************************************************************************/
1279PDFTOOLS_EXPORT TPdfTools_HttpClientHandler* PDFTOOLS_CALL PdfTools_HttpClientHandler_New(void);
1280
1305PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1306PdfTools_HttpClientHandler_SetClientCertificateA(TPdfTools_HttpClientHandler* pHttpClientHandler,
1307 const TPdfToolsSys_StreamDescriptor* pArchive, const char* szPassword);
1332PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateW(
1333 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pArchive,
1334 const WCHAR* szPassword);
1360PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateAndKeyA(
1361 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pCert,
1362 const TPdfToolsSys_StreamDescriptor* pKey, const char* szPassword);
1388PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetClientCertificateAndKeyW(
1389 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pCert,
1390 const TPdfToolsSys_StreamDescriptor* pKey, const WCHAR* szPassword);
1412PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_AddTrustedCertificate(
1413 TPdfTools_HttpClientHandler* pHttpClientHandler, const TPdfToolsSys_StreamDescriptor* pCert);
1414
1435PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
1436PdfTools_HttpClientHandler_GetSslVerifyServerCertificate(TPdfTools_HttpClientHandler* pHttpClientHandler);
1457PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfTools_HttpClientHandler_SetSslVerifyServerCertificate(
1458 TPdfTools_HttpClientHandler* pHttpClientHandler, BOOL bSslVerifyServerCertificate);
1459
1460#ifdef __cplusplus
1461}
1462#endif
1463
1464#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_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_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:3333
TPdfToolsSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49
Generated by doxygen 1.10.0