PdfToolbox_Ptx.h

Go to the documentation of this file.

/******************************************************************************
 *
 * File:            PdfToolbox_Ptx.h
 *
 * Description:     Sub Header file for PDF Toolbox API
 *
 * Author:          PDF Tools AG
 *
 * Copyright:       Copyright (C) 2015 - 2025 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 PDFTOOLBOX_PTX_H__
#define PDFTOOLBOX_PTX_H__
 
#ifndef PDFTOOLBOX_CALL
#if defined(WIN32)
#define PDFTOOLBOX_CALL __stdcall
#else
#define PDFTOOLBOX_CALL
#endif
#endif
 
#include "PdfToolbox_Types.h"
#include "PdfToolbox_PtxSys.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#ifdef _UNICODE
#define Ptx_GetLastErrorMessage Ptx_GetLastErrorMessageW
#define Ptx_Sdk_Initialize      Ptx_Sdk_InitializeW
 
#define Ptx_Sdk_GetVersion Ptx_Sdk_GetVersionW
 
#define Ptx_Sdk_GetProducerFullName Ptx_Sdk_GetProducerFullNameW
 
#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_GetVersion Ptx_Sdk_GetVersionA
 
#define Ptx_Sdk_GetProducerFullName Ptx_Sdk_GetProducerFullNameA
 
#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
 *****************************************************************************/
 
PDFTOOLBOX_EXPORT void PDFTOOLBOX_CALL Ptx_Initialize();
 
PDFTOOLBOX_EXPORT void PDFTOOLBOX_CALL Ptx_Uninitialize();
 
PDFTOOLBOX_EXPORT TPtx_ErrorCode PDFTOOLBOX_CALL Ptx_GetLastError();
 
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_GetLastErrorMessageA(char* pBuffer, size_t nBufferSize);
 
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_GetLastErrorMessageW(WCHAR* pBuffer, size_t nBufferSize);
 
PDFTOOLBOX_EXPORT void PDFTOOLBOX_CALL Ptx_SetLastErrorA(TPtx_ErrorCode iErrorCode, const char* szErrorMessage);
 
PDFTOOLBOX_EXPORT void PDFTOOLBOX_CALL Ptx_SetLastErrorW(TPtx_ErrorCode iErrorCode, const WCHAR* szErrorMessage);
 
/******************************************************************************
 * Object
 *****************************************************************************/
PDFTOOLBOX_EXPORT void PDFTOOLBOX_CALL Ptx_Release(void* pObject);
 
PDFTOOLBOX_EXPORT void PDFTOOLBOX_CALL Ptx_AddRef(void* pObject);
 
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_Equals(void* pObject, void* pOther);
 
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_GetHashCode(void* pObject);
/******************************************************************************
 * Sdk
 *****************************************************************************/
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_Sdk_InitializeA(const char* szLicense, const char* szProducerSuffix);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_Sdk_InitializeW(const WCHAR* szLicense, const WCHAR* szProducerSuffix);
 
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_Sdk_GetVersionA(char* pBuffer, size_t nBufferSize);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_Sdk_GetVersionW(WCHAR* pBuffer, size_t nBufferSize);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_Sdk_GetProducerFullNameA(char* pBuffer, size_t nBufferSize);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_Sdk_GetProducerFullNameW(WCHAR* pBuffer, size_t nBufferSize);
 
/******************************************************************************
 * StringMap
 *****************************************************************************/
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetCount(TPtx_StringMap* pStringMap);
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetSize(TPtx_StringMap* pStringMap);
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetBegin(TPtx_StringMap* pStringMap);
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetEnd(TPtx_StringMap* pStringMap);
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetNext(TPtx_StringMap* pStringMap, int it);
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetA(TPtx_StringMap* pStringMap, const char* szKey);
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL Ptx_StringMap_GetW(TPtx_StringMap* pStringMap, const WCHAR* szKey);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_StringMap_GetKeyA(TPtx_StringMap* pStringMap, int it, char* pBuffer,
                                                               size_t nBufferSize);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_StringMap_GetKeyW(TPtx_StringMap* pStringMap, int it, WCHAR* pBuffer,
                                                               size_t nBufferSize);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_StringMap_GetValueA(TPtx_StringMap* pStringMap, int it, char* pBuffer,
                                                                 size_t nBufferSize);
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL Ptx_StringMap_GetValueW(TPtx_StringMap* pStringMap, int it, WCHAR* pBuffer,
                                                                 size_t nBufferSize);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_StringMap_SetA(TPtx_StringMap* pStringMap, const char* szKey,
                                                          const char* szValue);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_StringMap_SetW(TPtx_StringMap* pStringMap, const WCHAR* szKey,
                                                          const WCHAR* szValue);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_StringMap_SetValueA(TPtx_StringMap* pStringMap, int it, const char* szValue);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_StringMap_SetValueW(TPtx_StringMap* pStringMap, int it,
                                                               const WCHAR* szValue);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_StringMap_Clear(TPtx_StringMap* pStringMap);
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL Ptx_StringMap_Remove(TPtx_StringMap* pStringMap, int it);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PDFTOOLBOX_PTX_H__ */