1.2/cdoc/_pdf_tools___toolbox___ptx_8h_source.html

/******************************************************************************

 *

 * File:            PdfTools_Toolbox_Ptx.h

 *

 * Description:     Sub Header file for Toolbox SDK

 *

 * Author:          PDF Tools AG

 *

 * Copyright:       Copyright (C) 2024 - 2024 PDF Tools AG, Switzerland

 *                  All rights reserved.

 *

 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's

 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),

 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),

 *                  and allow PDF Tools AG to track your usage data.

 *

 *****************************************************************************/


#ifndef PDFTOOLS_TOOLBOX_PTX_H__

#define PDFTOOLS_TOOLBOX_PTX_H__


#ifndef PDFTOOLS_TOOLBOX_CALL

#if defined(WIN32)

#define PDFTOOLS_TOOLBOX_CALL __stdcall

#else

#define PDFTOOLS_TOOLBOX_CALL

#endif

#endif


#include "PdfTools_Toolbox_Types.h"

#include "PdfTools_Toolbox_PtxSys.h"


#ifdef __cplusplus

extern "C"

{

#endif


#ifdef _UNICODE

#define Ptx_GetLastErrorMessage  Ptx_GetLastErrorMessageW

#define Ptx_Sdk_Initialize       Ptx_Sdk_InitializeW

#define Ptx_Sdk_AddFontDirectory Ptx_Sdk_AddFontDirectoryW


#define Ptx_Sdk_GetVersion Ptx_Sdk_GetVersionW


#define Ptx_Sdk_GetProducerFullName Ptx_Sdk_GetProducerFullNameW


#define Ptx_Sdk_GetLicensingService Ptx_Sdk_GetLicensingServiceW

#define Ptx_Sdk_SetLicensingService Ptx_Sdk_SetLicensingServiceW


#define Ptx_StringMap_Get      Ptx_StringMap_GetW

#define Ptx_StringMap_GetKey   Ptx_StringMap_GetKeyW

#define Ptx_StringMap_GetValue Ptx_StringMap_GetValueW

#define Ptx_StringMap_Set      Ptx_StringMap_SetW

#define Ptx_StringMap_SetValue Ptx_StringMap_SetValueW


#else

#define Ptx_GetLastErrorMessage  Ptx_GetLastErrorMessageA

#define Ptx_Sdk_Initialize       Ptx_Sdk_InitializeA

#define Ptx_Sdk_AddFontDirectory Ptx_Sdk_AddFontDirectoryA


#define Ptx_Sdk_GetVersion Ptx_Sdk_GetVersionA


#define Ptx_Sdk_GetProducerFullName Ptx_Sdk_GetProducerFullNameA


#define Ptx_Sdk_GetLicensingService Ptx_Sdk_GetLicensingServiceA

#define Ptx_Sdk_SetLicensingService Ptx_Sdk_SetLicensingServiceA


#define Ptx_StringMap_Get      Ptx_StringMap_GetA

#define Ptx_StringMap_GetKey   Ptx_StringMap_GetKeyA

#define Ptx_StringMap_GetValue Ptx_StringMap_GetValueA

#define Ptx_StringMap_Set      Ptx_StringMap_SetA

#define Ptx_StringMap_SetValue Ptx_StringMap_SetValueA


#endif


/******************************************************************************

 * Library

 *****************************************************************************/


PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Initialize();


PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Uninitialize();


PDFTOOLS_TOOLBOX_EXPORT TPtx_ErrorCode PDFTOOLS_TOOLBOX_CALL Ptx_GetLastError();


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_GetLastErrorMessageA(char* pBuffer, size_t nBufferSize);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_GetLastErrorMessageW(WCHAR* pBuffer, size_t nBufferSize);


PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_SetLastErrorA(TPtx_ErrorCode iErrorCode,

                                                                     const char*    szErrorMessage);


PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_SetLastErrorW(TPtx_ErrorCode iErrorCode,

                                                                     const WCHAR*   szErrorMessage);


/******************************************************************************

 * Object

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Release(void* pObject);


PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_AddRef(void* pObject);


PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Equals(void* pObject, void* pOther);


PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_GetHashCode(void* pObject);

/******************************************************************************

 * Sdk

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_InitializeA(const char* szLicense,

                                                                       const char* szProducerSuffix);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_InitializeW(const WCHAR* szLicense,

                                                                       const WCHAR* szProducerSuffix);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_AddFontDirectoryA(const char* szDirectory);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_AddFontDirectoryW(const WCHAR* szDirectory);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionA(char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionW(WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetProducerFullNameA(char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetProducerFullNameW(WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetLicensingServiceA(char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetLicensingServiceW(WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_SetLicensingServiceA(const char* szLicensingService);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_SetLicensingServiceW(const WCHAR* szLicensingService);


/******************************************************************************

 * StringMap

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetCount(TPtx_StringMap* pStringMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetSize(TPtx_StringMap* pStringMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetBegin(TPtx_StringMap* pStringMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetEnd(TPtx_StringMap* pStringMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetNext(TPtx_StringMap* pStringMap, int it);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetA(TPtx_StringMap* pStringMap, const char* szKey);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetW(TPtx_StringMap* pStringMap, const WCHAR* szKey);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetKeyA(TPtx_StringMap* pStringMap, int it,

                                                                           char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetKeyW(TPtx_StringMap* pStringMap, int it,

                                                                           WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetValueA(TPtx_StringMap* pStringMap, int it,

                                                                             char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetValueW(TPtx_StringMap* pStringMap, int it,

                                                                             WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetA(TPtx_StringMap* pStringMap, const char* szKey,

                                                                      const char* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetW(TPtx_StringMap* pStringMap, const WCHAR* szKey,

                                                                      const WCHAR* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetValueA(TPtx_StringMap* pStringMap, int it,

                                                                           const char* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_SetValueW(TPtx_StringMap* pStringMap, int it,

                                                                           const WCHAR* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_Clear(TPtx_StringMap* pStringMap);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_Remove(TPtx_StringMap* pStringMap, int it);


#ifdef __cplusplus

}

#endif


#endif /* PDFTOOLS_TOOLBOX_PTX_H__ */

PDFTOOLS_TOOLBOX_EXPORT
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143

WCHAR
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95

Ptx_Sdk_GetVersionA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionA(char *pBuffer, size_t nBufferSize)

Ptx_Sdk_GetVersionW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetVersionW(WCHAR *pBuffer, size_t nBufferSize)

Ptx_AddRef
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_AddRef(void *pObject)
Increase reference count of object.

Ptx_StringMap_GetKeyW
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.

Ptx_StringMap_SetValueA
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.

Ptx_SetLastErrorA
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_SetLastErrorA(TPtx_ErrorCode iErrorCode, const char *szErrorMessage)
Set last error code and error message.

Ptx_GetHashCode
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_GetHashCode(void *pObject)
Get a hash code.

Ptx_Sdk_GetProducerFullNameW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetProducerFullNameW(WCHAR *pBuffer, size_t nBufferSize)

Ptx_StringMap_GetBegin
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetBegin(TPtx_StringMap *pStringMap)
Get the position of the first entry in the map.

Ptx_StringMap_GetEnd
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetEnd(TPtx_StringMap *pStringMap)
Get the end position of the map.

Ptx_Sdk_SetLicensingServiceW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_SetLicensingServiceW(const WCHAR *szLicensingService)
Licensing service to use for all licensing requests.

Ptx_Equals
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Equals(void *pObject, void *pOther)
Compare two native objects.

Ptx_GetLastError
PDFTOOLS_TOOLBOX_EXPORT TPtx_ErrorCode PDFTOOLS_TOOLBOX_CALL Ptx_GetLastError()
Retrieves the last error code.

Ptx_Sdk_InitializeA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_InitializeA(const char *szLicense, const char *szProducerSuffix)

PDFTOOLS_TOOLBOX_CALL
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_Ptx.h:26

Ptx_StringMap_GetW
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 ...

Ptx_StringMap_Clear
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_Clear(TPtx_StringMap *pStringMap)
Remove all entries from the map.

Ptx_StringMap_GetValueA
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.

Ptx_StringMap_SetValueW
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.

Ptx_StringMap_GetNext
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.

Ptx_Sdk_GetLicensingServiceW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetLicensingServiceW(WCHAR *pBuffer, size_t nBufferSize)
Licensing service to use for all licensing requests.

Ptx_GetLastErrorMessageA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_GetLastErrorMessageA(char *pBuffer, size_t nBufferSize)
Retrieves the last error message.

Ptx_Sdk_AddFontDirectoryA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_AddFontDirectoryA(const char *szDirectory)
Add custom font directory.

Ptx_Sdk_AddFontDirectoryW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_AddFontDirectoryW(const WCHAR *szDirectory)
Add custom font directory.

Ptx_Sdk_GetLicensingServiceA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetLicensingServiceA(char *pBuffer, size_t nBufferSize)
Licensing service to use for all licensing requests.

Ptx_Release
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Release(void *pObject)
Release object.

Ptx_StringMap_GetKeyA
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.

Ptx_StringMap_GetA
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 ...

Ptx_Initialize
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Initialize()
Initializes the library.

Ptx_StringMap_GetSize
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetSize(TPtx_StringMap *pStringMap)
The number of key-value pairs in the map.

Ptx_Sdk_SetLicensingServiceA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_SetLicensingServiceA(const char *szLicensingService)
Licensing service to use for all licensing requests.

Ptx_SetLastErrorW
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_SetLastErrorW(TPtx_ErrorCode iErrorCode, const WCHAR *szErrorMessage)
Set last error code and error message.

Ptx_StringMap_SetA
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...

Ptx_GetLastErrorMessageW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_GetLastErrorMessageW(WCHAR *pBuffer, size_t nBufferSize)
Retrieve last error message.

Ptx_Uninitialize
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL Ptx_Uninitialize()
Uninitializes the library.

Ptx_Sdk_GetProducerFullNameA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_GetProducerFullNameA(char *pBuffer, size_t nBufferSize)

Ptx_StringMap_GetCount
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_GetCount(TPtx_StringMap *pStringMap)
The number of key-value pairs in the map.

Ptx_StringMap_GetValueW
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.

Ptx_Sdk_InitializeW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_Sdk_InitializeW(const WCHAR *szLicense, const WCHAR *szProducerSuffix)

Ptx_StringMap_SetW
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...

Ptx_StringMap_Remove
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL Ptx_StringMap_Remove(TPtx_StringMap *pStringMap, int it)
Remove the entry at a position in the map.

PdfTools_Toolbox_PtxSys.h

PdfTools_Toolbox_Types.h

TPtx_ErrorCode
TPtx_ErrorCode
Definition PdfTools_Toolbox_Types.h:34

BOOL
#define BOOL
Definition PdfTools_Toolbox_Types.h:23

TPtx_StringMap