PDF Toolbox
Loading...
Searching...
No Matches
PdfTools_Toolbox_Ptx.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_Toolbox_Ptx.h
4 *
5 * Description: Sub Header file for Toolbox SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2024 - 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_TOOLBOX_PTX_H__
20#define PDFTOOLS_TOOLBOX_PTX_H__
21
22#ifndef PDFTOOLS_TOOLBOX_CALL
23#if defined(WIN32)
24#define PDFTOOLS_TOOLBOX_CALL __stdcall
25#else
26#define PDFTOOLS_TOOLBOX_CALL
27#endif
28#endif
29
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define Ptx_GetLastErrorMessage Ptx_GetLastErrorMessageW
40#define Ptx_Sdk_Initialize Ptx_Sdk_InitializeW
41#define Ptx_Sdk_AddFontDirectory Ptx_Sdk_AddFontDirectoryW
42
43#define Ptx_Sdk_GetVersion Ptx_Sdk_GetVersionW
44
45#define Ptx_Sdk_GetProducerFullName Ptx_Sdk_GetProducerFullNameW
46
47#define Ptx_Sdk_GetLicensingService Ptx_Sdk_GetLicensingServiceW
48#define Ptx_Sdk_SetLicensingService Ptx_Sdk_SetLicensingServiceW
49
50#define Ptx_StringMap_Get Ptx_StringMap_GetW
51#define Ptx_StringMap_GetKey Ptx_StringMap_GetKeyW
52#define Ptx_StringMap_GetValue Ptx_StringMap_GetValueW
53#define Ptx_StringMap_Set Ptx_StringMap_SetW
54#define Ptx_StringMap_SetValue Ptx_StringMap_SetValueW
55
56#else
57#define Ptx_GetLastErrorMessage Ptx_GetLastErrorMessageA
58#define Ptx_Sdk_Initialize Ptx_Sdk_InitializeA
59#define Ptx_Sdk_AddFontDirectory Ptx_Sdk_AddFontDirectoryA
60
61#define Ptx_Sdk_GetVersion Ptx_Sdk_GetVersionA
62
63#define Ptx_Sdk_GetProducerFullName Ptx_Sdk_GetProducerFullNameA
64
65#define Ptx_Sdk_GetLicensingService Ptx_Sdk_GetLicensingServiceA
66#define Ptx_Sdk_SetLicensingService Ptx_Sdk_SetLicensingServiceA
67
68#define Ptx_StringMap_Get Ptx_StringMap_GetA
69#define Ptx_StringMap_GetKey Ptx_StringMap_GetKeyA
70#define Ptx_StringMap_GetValue Ptx_StringMap_GetValueA
71#define Ptx_StringMap_Set Ptx_StringMap_SetA
72#define Ptx_StringMap_SetValue Ptx_StringMap_SetValueA
73
74#endif
75
76/******************************************************************************
77 * Library
78 *****************************************************************************/
79
87
95
104
119
134
144 const char* szErrorMessage);
145
155 const WCHAR* szErrorMessage);
156
157/******************************************************************************
158 * Object
159 *****************************************************************************/
169
178
190
201/******************************************************************************
202 * Sdk
203 *****************************************************************************/
225 const char* szProducerSuffix);
247 const WCHAR* szProducerSuffix);
278
294PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionA(char* pBuffer, size_t nBufferSize);
481
482/******************************************************************************
483 * StringMap
484 *****************************************************************************/
635 char* pBuffer, size_t nBufferSize);
658 WCHAR* pBuffer, size_t nBufferSize);
681 char* pBuffer, size_t nBufferSize);
704 WCHAR* pBuffer, size_t nBufferSize);
725 const char* szValue);
746 const WCHAR* szValue);
764 const char* szValue);
782 const WCHAR* szValue);
813
814#ifdef __cplusplus
815}
816#endif
817
818#endif /* PDFTOOLS_TOOLBOX_PTX_H__ */
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionA(char *pBuffer, size_t nBufferSize)
The version of the Toolbox add-on.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionW(WCHAR *pBuffer, size_t nBufferSize)
The version of the Toolbox add-on.
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_AddRef(void *pObject)
Increase reference count of object.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetKeyW(TPtx_StringMap *pStringMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetValueA(TPtx_StringMap *pStringMap, int it, const char *szValue)
Set the value of the entry at a position in the map.
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_SetLastErrorA(TPtx_ErrorCode iErrorCode, const char *szErrorMessage)
Set last error code and error message.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_GetHashCode(void *pObject)
Get a hash code.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetProducerFullNameW(WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetBegin(TPtx_StringMap *pStringMap)
Get the position of the first entry in the map.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetEnd(TPtx_StringMap *pStringMap)
Get the end position of the map.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_SetLicensingServiceW(const WCHAR *szLicensingService)
Licensing service to use for all licensing requests.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Equals(void *pObject, void *pOther)
Compare two native objects.
PDFTOOLS_TOOLBOX_EXPORT TPtx_ErrorCode PDFTOOLS_TOOLBOX_CALL Ptx_GetLastError()
Retrieves the last error code.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_InitializeA(const char *szLicense, const char *szProducerSuffix)
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_Ptx.h:26
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetW(TPtx_StringMap *pStringMap, 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_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_Clear(TPtx_StringMap *pStringMap)
Remove all entries from the map.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetValueA(TPtx_StringMap *pStringMap, int it, char *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetValueW(TPtx_StringMap *pStringMap, int it, const WCHAR *szValue)
Set the value of the entry at a position in the map.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetNext(TPtx_StringMap *pStringMap, int it)
Get the position of the next entry in the map.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetLicensingServiceW(WCHAR *pBuffer, size_t nBufferSize)
Licensing service to use for all licensing requests.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_GetLastErrorMessageA(char *pBuffer, size_t nBufferSize)
Retrieves the last error message.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_AddFontDirectoryA(const char *szDirectory)
Add custom font directory.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_AddFontDirectoryW(const WCHAR *szDirectory)
Add custom font directory.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetLicensingServiceA(char *pBuffer, size_t nBufferSize)
Licensing service to use for all licensing requests.
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Release(void *pObject)
Release object.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetKeyA(TPtx_StringMap *pStringMap, int it, char *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetA(TPtx_StringMap *pStringMap, 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_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Initialize()
Initializes the library.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetSize(TPtx_StringMap *pStringMap)
The number of key-value pairs in the map.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_SetLicensingServiceA(const char *szLicensingService)
Licensing service to use for all licensing requests.
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_SetLastErrorW(TPtx_ErrorCode iErrorCode, const WCHAR *szErrorMessage)
Set last error code and error message.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetA(TPtx_StringMap *pStringMap, const char *szKey, const char *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_GetLastErrorMessageW(WCHAR *pBuffer, size_t nBufferSize)
Retrieve last error message.
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Uninitialize()
Uninitializes the library.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetProducerFullNameA(char *pBuffer, size_t nBufferSize)
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetCount(TPtx_StringMap *pStringMap)
The number of key-value pairs in the map.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetValueW(TPtx_StringMap *pStringMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_InitializeW(const WCHAR *szLicense, const WCHAR *szProducerSuffix)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetW(TPtx_StringMap *pStringMap, const WCHAR *szKey, const WCHAR *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_Remove(TPtx_StringMap *pStringMap, int it)
Remove the entry at a position in the map.
TPtx_ErrorCode
Definition PdfTools_Toolbox_Types.h:34
#define BOOL
Definition PdfTools_Toolbox_Types.h:23