1.3/cdoc/_pdf_tools___toolbox___ptx_pdf_8h_source.html

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

 *

 * File:            PdfTools_Toolbox_PtxPdf.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_PTXPDF_H__

#define PDFTOOLS_TOOLBOX_PTXPDF_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 PtxPdf_Encryption_New              PtxPdf_Encryption_NewW

#define PtxPdf_Encryption_GetUserPassword  PtxPdf_Encryption_GetUserPasswordW

#define PtxPdf_Encryption_SetUserPassword  PtxPdf_Encryption_SetUserPasswordW

#define PtxPdf_Encryption_GetOwnerPassword PtxPdf_Encryption_GetOwnerPasswordW

#define PtxPdf_Encryption_SetOwnerPassword PtxPdf_Encryption_SetOwnerPasswordW


#define PtxPdf_OptionalContentGroup_GetName PtxPdf_OptionalContentGroup_GetNameW


#define PtxPdf_Document_Open        PtxPdf_Document_OpenW

#define PtxPdf_Document_OpenWithFdf PtxPdf_Document_OpenWithFdfW


#define PtxPdf_Document_GetLanguage PtxPdf_Document_GetLanguageW

#define PtxPdf_Document_SetLanguage PtxPdf_Document_SetLanguageW


#define PtxPdf_Page_GetPageLabel PtxPdf_Page_GetPageLabelW


#define PtxPdf_Metadata_GetTitle    PtxPdf_Metadata_GetTitleW

#define PtxPdf_Metadata_SetTitle    PtxPdf_Metadata_SetTitleW

#define PtxPdf_Metadata_GetAuthor   PtxPdf_Metadata_GetAuthorW

#define PtxPdf_Metadata_SetAuthor   PtxPdf_Metadata_SetAuthorW

#define PtxPdf_Metadata_GetSubject  PtxPdf_Metadata_GetSubjectW

#define PtxPdf_Metadata_SetSubject  PtxPdf_Metadata_SetSubjectW

#define PtxPdf_Metadata_GetKeywords PtxPdf_Metadata_GetKeywordsW

#define PtxPdf_Metadata_SetKeywords PtxPdf_Metadata_SetKeywordsW

#define PtxPdf_Metadata_GetCreator  PtxPdf_Metadata_GetCreatorW

#define PtxPdf_Metadata_SetCreator  PtxPdf_Metadata_SetCreatorW

#define PtxPdf_Metadata_GetProducer PtxPdf_Metadata_GetProducerW


#define PtxPdf_FileReference_Create PtxPdf_FileReference_CreateW


#define PtxPdf_FileReference_GetAssociationRelationship PtxPdf_FileReference_GetAssociationRelationshipW

#define PtxPdf_FileReference_SetAssociationRelationship PtxPdf_FileReference_SetAssociationRelationshipW

#define PtxPdf_FileReference_GetDescription             PtxPdf_FileReference_GetDescriptionW


#define PtxPdf_FileReference_GetMediaType PtxPdf_FileReference_GetMediaTypeW


#define PtxPdf_FileReference_GetName PtxPdf_FileReference_GetNameW


#else

#define PtxPdf_Encryption_New              PtxPdf_Encryption_NewA

#define PtxPdf_Encryption_GetUserPassword  PtxPdf_Encryption_GetUserPasswordA

#define PtxPdf_Encryption_SetUserPassword  PtxPdf_Encryption_SetUserPasswordA

#define PtxPdf_Encryption_GetOwnerPassword PtxPdf_Encryption_GetOwnerPasswordA

#define PtxPdf_Encryption_SetOwnerPassword PtxPdf_Encryption_SetOwnerPasswordA


#define PtxPdf_OptionalContentGroup_GetName PtxPdf_OptionalContentGroup_GetNameA


#define PtxPdf_Document_Open        PtxPdf_Document_OpenA

#define PtxPdf_Document_OpenWithFdf PtxPdf_Document_OpenWithFdfA


#define PtxPdf_Document_GetLanguage PtxPdf_Document_GetLanguageA

#define PtxPdf_Document_SetLanguage PtxPdf_Document_SetLanguageA


#define PtxPdf_Page_GetPageLabel PtxPdf_Page_GetPageLabelA


#define PtxPdf_Metadata_GetTitle    PtxPdf_Metadata_GetTitleA

#define PtxPdf_Metadata_SetTitle    PtxPdf_Metadata_SetTitleA

#define PtxPdf_Metadata_GetAuthor   PtxPdf_Metadata_GetAuthorA

#define PtxPdf_Metadata_SetAuthor   PtxPdf_Metadata_SetAuthorA

#define PtxPdf_Metadata_GetSubject  PtxPdf_Metadata_GetSubjectA

#define PtxPdf_Metadata_SetSubject  PtxPdf_Metadata_SetSubjectA

#define PtxPdf_Metadata_GetKeywords PtxPdf_Metadata_GetKeywordsA

#define PtxPdf_Metadata_SetKeywords PtxPdf_Metadata_SetKeywordsA

#define PtxPdf_Metadata_GetCreator  PtxPdf_Metadata_GetCreatorA

#define PtxPdf_Metadata_SetCreator  PtxPdf_Metadata_SetCreatorA

#define PtxPdf_Metadata_GetProducer PtxPdf_Metadata_GetProducerA


#define PtxPdf_FileReference_Create PtxPdf_FileReference_CreateA


#define PtxPdf_FileReference_GetAssociationRelationship PtxPdf_FileReference_GetAssociationRelationshipA

#define PtxPdf_FileReference_SetAssociationRelationship PtxPdf_FileReference_SetAssociationRelationshipA

#define PtxPdf_FileReference_GetDescription             PtxPdf_FileReference_GetDescriptionA


#define PtxPdf_FileReference_GetMediaType PtxPdf_FileReference_GetMediaTypeA


#define PtxPdf_FileReference_GetName PtxPdf_FileReference_GetNameA


#endif


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

 * PageCopyOptions

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageCopyOptions* PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_New(void);


PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetLinks(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_SetLinks(TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_CopyStrategy iLinks);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FormFieldCopyStrategy PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetFormFields(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetFormFields(

    TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdfForms_FormFieldCopyStrategy iFormFields);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_RemovalStrategy PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetSignedSignatures(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetSignedSignatures(

    TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_RemovalStrategy iSignedSignatures);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetUnsignedSignatures(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetUnsignedSignatures(

    TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_CopyStrategy iUnsignedSignatures);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetAnnotations(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_SetAnnotations(TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_CopyStrategy iAnnotations);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetCopyOutlineItems(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_SetCopyOutlineItems(TPtxPdf_PageCopyOptions* pPageCopyOptions, BOOL bCopyOutlineItems);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetCopyAssociatedFiles(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_SetCopyAssociatedFiles(TPtxPdf_PageCopyOptions* pPageCopyOptions, BOOL bCopyAssociatedFiles);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetCopyLogicalStructure(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_SetCopyLogicalStructure(TPtxPdf_PageCopyOptions* pPageCopyOptions, BOOL bCopyLogicalStructure);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_NameConflictResolution PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetFormFieldConflictResolution(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetFormFieldConflictResolution(

    TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_NameConflictResolution iFormFieldConflictResolution);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_NameConflictResolution PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetOcgConflictResolution(

    TPtxPdf_PageCopyOptions*

        pPageCopyOptions); // Deprecated in Version 1.0. Setting this property has no effect. When copying pages from

                           // multiple documents, layers (optional content groups, OCG) are always merged.

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetOcgConflictResolution(

    TPtxPdf_PageCopyOptions* pPageCopyOptions,

    TPtxPdf_NameConflictResolution

        iOcgConflictResolution); // Deprecated in Version 1.0. Setting this property has no effect. When copying pages

                                 // from multiple documents, layers (optional content groups, OCG) are always merged.

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetNamedDestinations(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetNamedDestinations(

    TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_GetOptimizeResources(TPtxPdf_PageCopyOptions* pPageCopyOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_PageCopyOptions_SetOptimizeResources(TPtxPdf_PageCopyOptions* pPageCopyOptions, BOOL bOptimizeResources);


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

 * Encryption

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Encryption* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Encryption_NewA(const char* szUserPassword, const char* szOwnerPassword, TPtxPdf_Permission iPermissions);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Encryption* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Encryption_NewW(const WCHAR* szUserPassword, const WCHAR* szOwnerPassword, TPtxPdf_Permission iPermissions);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetUserPasswordA(TPtxPdf_Encryption* pEncryption,

                                                                                        char*               pBuffer,

                                                                                        size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetUserPasswordW(TPtxPdf_Encryption* pEncryption,

                                                                                        WCHAR*              pBuffer,

                                                                                        size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetUserPasswordA(TPtxPdf_Encryption* pEncryption,

                                                                                      const char* szUserPassword);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetUserPasswordW(TPtxPdf_Encryption* pEncryption,

                                                                                      const WCHAR* szUserPassword);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_Encryption_GetOwnerPasswordA(TPtxPdf_Encryption* pEncryption, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_Encryption_GetOwnerPasswordW(TPtxPdf_Encryption* pEncryption, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetOwnerPasswordA(TPtxPdf_Encryption* pEncryption,

                                                                                       const char* szOwnerPassword);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetOwnerPasswordW(TPtxPdf_Encryption* pEncryption,

                                                                                       const WCHAR* szOwnerPassword);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Permission PDFTOOLS_TOOLBOX_CALL

PtxPdf_Encryption_GetPermissions(TPtxPdf_Encryption* pEncryption);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetPermissions(TPtxPdf_Encryption* pEncryption,

                                                                                    TPtxPdf_Permission  iPermissions);


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

 * PageList

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageList* PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_Copy(TPtxPdf_Document* pTargetDocument,

                                                                                     TPtxPdf_PageList* pPageList,

                                                                                     TPtxPdf_PageCopyOptions* pOptions);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_GetCount(TPtxPdf_PageList* pPageList);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page* PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_Get(TPtxPdf_PageList* pPageList,

                                                                                int               iIndex);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageList* PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_GetRange(TPtxPdf_PageList* pPageList,

                                                                                         int iIndex, int iCount);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_Add(TPtxPdf_PageList* pPageList,

                                                                       TPtxPdf_Page*     pPage);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_AddRange(TPtxPdf_PageList* pPageList,

                                                                            TPtxPdf_PageList* pInput);


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

 * FileReferenceList

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

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReferenceList_GetCount(TPtxPdf_FileReferenceList* pFileReferenceList);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference* PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReferenceList_Get(TPtxPdf_FileReferenceList* pFileReferenceList, int iIndex);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReferenceList_Add(TPtxPdf_FileReferenceList* pFileReferenceList, TPtxPdf_FileReference* pFileReference);


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

 * OptionalContentGroup

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

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroup_GetNameA(

    TPtxPdf_OptionalContentGroup* pOptionalContentGroup, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroup_GetNameW(

    TPtxPdf_OptionalContentGroup* pOptionalContentGroup, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_OcgState PDFTOOLS_TOOLBOX_CALL

PtxPdf_OptionalContentGroup_GetState(TPtxPdf_OptionalContentGroup* pOptionalContentGroup);


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

 * OptionalContentGroupList

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

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL

PtxPdf_OptionalContentGroupList_GetCount(TPtxPdf_OptionalContentGroupList* pOptionalContentGroupList);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_OptionalContentGroup* PDFTOOLS_TOOLBOX_CALL

PtxPdf_OptionalContentGroupList_Get(TPtxPdf_OptionalContentGroupList* pOptionalContentGroupList, int iIndex);


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

 * Document

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_OpenA(const TPtxSys_StreamDescriptor* pStreamDesc, const char* szPassword);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_OpenW(const TPtxSys_StreamDescriptor* pStreamDesc, const WCHAR* szPassword);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_OpenWithFdfA(const TPtxSys_StreamDescriptor* pPdfStreamDesc,

                             const TPtxSys_StreamDescriptor* pFdfStreamDesc, const char* szPassword);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_OpenWithFdfW(const TPtxSys_StreamDescriptor* pPdfStreamDesc,

                             const TPtxSys_StreamDescriptor* pFdfStreamDesc, const WCHAR* szPassword);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_Create(const TPtxSys_StreamDescriptor* pStreamDesc, const TPtxPdf_Conformance* pConformance,

                       TPtxPdf_Encryption* pEncryption);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document* PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_CreateWithFdf(

    const TPtxSys_StreamDescriptor* pPdfStreamDesc, const TPtxSys_StreamDescriptor* pFdfStreamDesc,

    const TPtxPdf_Conformance* pConformance, TPtxPdf_Encryption* pEncryption);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetLanguageA(TPtxPdf_Document* pDocument,

                                                                                  char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetLanguageW(TPtxPdf_Document* pDocument,

                                                                                  WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetLanguageA(TPtxPdf_Document* pDocument,

                                                                                const char*       szLanguage);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetLanguageW(TPtxPdf_Document* pDocument,

                                                                                const WCHAR*      szLanguage);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_OptionalContentGroupList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetOptionalContentGroups(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Conformance PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetConformance(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetMetadata(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetMetadata(TPtxPdf_Document* pDocument,

                                                                               TPtxPdf_Metadata* pMetadata);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageList* PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetPages(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_IccBasedColorSpace* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetOutputIntent(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_SetOutputIntent(TPtxPdf_Document* pDocument, TPtxPdfContent_IccBasedColorSpace* pOutputIntent);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetFormFields(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignatureFieldList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetSignatureFields(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReferenceList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetPlainEmbeddedFiles(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReferenceList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetAssociatedFiles(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReferenceList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetAllEmbeddedFiles(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItemList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetOutline(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetOpenDestination(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_SetOpenDestination(TPtxPdf_Document* pDocument, TPtxPdfNav_Destination* pOpenDestination);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetPermissions(TPtxPdf_Document*   pDocument,

                                                                                  TPtxPdf_Permission* pPermissions);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_ViewerSettings* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_GetViewerSettings(TPtxPdf_Document* pDocument);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_Document_SetViewerSettings(TPtxPdf_Document* pDocument, TPtxPdfNav_ViewerSettings* pViewerSettings);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_IsLinearized(TPtxPdf_Document* pDocument);


PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_Close(TPtxPdf_Document* pObject);

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

 * Page

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page* PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_Create(TPtxPdf_Document*        pTargetDocument,

                                                                               const TPtxGeomReal_Size* pSize);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page* PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_Copy(TPtxPdf_Document*        pTargetDocument,

                                                                             TPtxPdf_Page*            pPage,

                                                                             TPtxPdf_PageCopyOptions* pOptions);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_UpdateSize(TPtxPdf_Page*                 pPage,

                                                                          const TPtxGeomReal_Rectangle* pRectangle);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_Rotate(TPtxPdf_Page* pPage, TPtxGeom_Rotation iRotate);


PDFTOOLS_TOOLBOX_EXPORT TPtxGeom_Rotation PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetRotation(TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetSize(TPtxPdf_Page* pPage, TPtxGeomReal_Size* pSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetMediaBox(TPtxPdf_Page*           pPage,

                                                                           TPtxGeomReal_Rectangle* pMediaBox);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetBleedBox(TPtxPdf_Page*           pPage,

                                                                           TPtxGeomReal_Rectangle* pBleedBox);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetTrimBox(TPtxPdf_Page*           pPage,

                                                                          TPtxGeomReal_Rectangle* pTrimBox);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetArtBox(TPtxPdf_Page*           pPage,

                                                                         TPtxGeomReal_Rectangle* pArtBox);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Content* PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetContent(TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_AnnotationList* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Page_GetAnnotations(TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LinkList* PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetLinks(TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_WidgetList* PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetWidgets(TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata* PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetMetadata(TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_SetMetadata(TPtxPdf_Page*     pPage,

                                                                           TPtxPdf_Metadata* pMetadata);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetPageLabelA(TPtxPdf_Page* pPage, char* pBuffer,

                                                                               size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetPageLabelW(TPtxPdf_Page* pPage, WCHAR* pBuffer,

                                                                               size_t nBufferSize);


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

 * Metadata

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Metadata_Create(TPtxPdf_Document* pTargetDocument, const TPtxSys_StreamDescriptor* pXmp);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata* PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_Copy(TPtxPdf_Document* pTargetDocument,

                                                                                     TPtxPdf_Metadata* pMetadata);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetTitleA(TPtxPdf_Metadata* pMetadata,

                                                                               char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetTitleW(TPtxPdf_Metadata* pMetadata,

                                                                               WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetTitleA(TPtxPdf_Metadata* pMetadata,

                                                                             const char*       szTitle);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetTitleW(TPtxPdf_Metadata* pMetadata,

                                                                             const WCHAR*      szTitle);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetAuthorA(TPtxPdf_Metadata* pMetadata,

                                                                                char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetAuthorW(TPtxPdf_Metadata* pMetadata,

                                                                                WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetAuthorA(TPtxPdf_Metadata* pMetadata,

                                                                              const char*       szAuthor);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetAuthorW(TPtxPdf_Metadata* pMetadata,

                                                                              const WCHAR*      szAuthor);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetSubjectA(TPtxPdf_Metadata* pMetadata,

                                                                                 char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetSubjectW(TPtxPdf_Metadata* pMetadata,

                                                                                 WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetSubjectA(TPtxPdf_Metadata* pMetadata,

                                                                               const char*       szSubject);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetSubjectW(TPtxPdf_Metadata* pMetadata,

                                                                               const WCHAR*      szSubject);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetKeywordsA(TPtxPdf_Metadata* pMetadata,

                                                                                  char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetKeywordsW(TPtxPdf_Metadata* pMetadata,

                                                                                  WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetKeywordsA(TPtxPdf_Metadata* pMetadata,

                                                                                const char*       szKeywords);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetKeywordsW(TPtxPdf_Metadata* pMetadata,

                                                                                const WCHAR*      szKeywords);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCreatorA(TPtxPdf_Metadata* pMetadata,

                                                                                 char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCreatorW(TPtxPdf_Metadata* pMetadata,

                                                                                 WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetCreatorA(TPtxPdf_Metadata* pMetadata,

                                                                               const char*       szCreator);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetCreatorW(TPtxPdf_Metadata* pMetadata,

                                                                               const WCHAR*      szCreator);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetProducerA(TPtxPdf_Metadata* pMetadata,

                                                                                  char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetProducerW(TPtxPdf_Metadata* pMetadata,

                                                                                  WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCreationDate(TPtxPdf_Metadata* pMetadata,

                                                                                   TPtxSys_Date*     pCreationDate);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetCreationDate(TPtxPdf_Metadata*   pMetadata,

                                                                                   const TPtxSys_Date* pCreationDate);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetModificationDate(TPtxPdf_Metadata* pMetadata,

                                                                                       TPtxSys_Date* pModificationDate);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetXmp(TPtxPdf_Metadata*         pMetadata,

                                                                          TPtxSys_StreamDescriptor* pOutStreamDesc);

PDFTOOLS_TOOLBOX_EXPORT TPtx_StringMap* PDFTOOLS_TOOLBOX_CALL

PtxPdf_Metadata_GetCustomEntries(TPtxPdf_Metadata* pMetadata);


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

 * FileReference

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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference* PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_CreateA(

    TPtxPdf_Document* pTargetDocument, const TPtxSys_StreamDescriptor* pData, const char* szName,

    const char* szMediaType, const char* szDescription, const TPtxSys_Date* pModificationDate);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference* PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_CreateW(

    TPtxPdf_Document* pTargetDocument, const TPtxSys_StreamDescriptor* pData, const WCHAR* szName,

    const WCHAR* szMediaType, const WCHAR* szDescription, const TPtxSys_Date* pModificationDate);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference* PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_Copy(TPtxPdf_Document* pTargetDocument, TPtxPdf_FileReference* pFileReference);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetAssociationRelationshipA(

    TPtxPdf_FileReference* pFileReference, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetAssociationRelationshipW(

    TPtxPdf_FileReference* pFileReference, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_SetAssociationRelationshipA(

    TPtxPdf_FileReference* pFileReference, const char* szAssociationRelationship);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_SetAssociationRelationshipW(

    TPtxPdf_FileReference* pFileReference, const WCHAR* szAssociationRelationship);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetDescriptionA(TPtxPdf_FileReference* pFileReference, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetDescriptionW(TPtxPdf_FileReference* pFileReference, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetMediaTypeA(TPtxPdf_FileReference* pFileReference, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetMediaTypeW(TPtxPdf_FileReference* pFileReference, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetModificationDate(TPtxPdf_FileReference* pFileReference, TPtxSys_Date* pModificationDate);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetNameA(TPtxPdf_FileReference* pFileReference, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetNameW(TPtxPdf_FileReference* pFileReference, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdf_FileReference_GetData(TPtxPdf_FileReference* pFileReference, TPtxSys_StreamDescriptor* pOutStreamDesc);


#ifdef __cplusplus

}

#endif


#endif /* PDFTOOLS_TOOLBOX_PTXPDF_H__ */

PDFTOOLS_TOOLBOX_EXPORT
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143

WCHAR
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95

PtxPdf_Page_GetPageLabelW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetPageLabelW(TPtxPdf_Page *pPage, WCHAR *pBuffer, size_t nBufferSize)
Page label.

PtxPdf_Page_GetSize
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetSize(TPtxPdf_Page *pPage, TPtxGeomReal_Size *pSize)
The visible size of the page (crop box).

PtxPdf_Document_SetViewerSettings
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetViewerSettings(TPtxPdf_Document *pDocument, TPtxPdfNav_ViewerSettings *pViewerSettings)

PtxPdf_PageCopyOptions_SetAnnotations
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetAnnotations(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_CopyStrategy iAnnotations)
Copy strategy for annotations.

PtxPdf_Page_GetTrimBox
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetTrimBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pTrimBox)
The trim box of the page.

PtxPdf_Page_GetBleedBox
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetBleedBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pBleedBox)
The bleed box of the page.

PtxPdf_FileReference_GetMediaTypeW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetMediaTypeW(TPtxPdf_FileReference *pFileReference, WCHAR *pBuffer, size_t nBufferSize)
The file's MIME type.

PtxPdf_PageCopyOptions_SetUnsignedSignatures
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetUnsignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_CopyStrategy iUnsignedSignatures)
Copy strategy for unsigned signature fields.

PtxPdf_FileReference_GetAssociationRelationshipW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetAssociationRelationshipW(TPtxPdf_FileReference *pFileReference, WCHAR *pBuffer, size_t nBufferSize)
The file's association relationship This property is NULL if the file is not associated with any obje...

PtxPdf_Page_GetWidgets
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetWidgets(TPtxPdf_Page *pPage)
the list of this page's form field widgets. Adding to this list results in an error:

PtxPdf_Metadata_GetKeywordsA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetKeywordsA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
Keywords associated with the document or resource.

PtxPdf_Document_OpenA
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_OpenA(const TPtxSys_StreamDescriptor *pStreamDesc, const char *szPassword)
Open a PDF document. Documents opened with this method are read-only and cannot be modified.

PtxPdf_Metadata_GetCustomEntries
PDFTOOLS_TOOLBOX_EXPORT TPtx_StringMap *PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCustomEntries(TPtxPdf_Metadata *pMetadata)
The custom entries in the document information dictionary.

PtxPdf_Document_GetOutline
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetOutline(TPtxPdf_Document *pDocument)

PtxPdf_Document_GetConformance
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Conformance PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetConformance(TPtxPdf_Document *pDocument)
the claimed conformance of the document. This method only returns the claimed conformance level,...

PtxPdf_Page_GetArtBox
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetArtBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pArtBox)
The art box of the page.

PtxPdf_Metadata_GetTitleA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetTitleA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP m...

PtxPdf_Encryption_NewA
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Encryption *PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_NewA(const char *szUserPassword, const char *szOwnerPassword, TPtxPdf_Permission iPermissions)

PtxPdf_Document_GetPermissions
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetPermissions(TPtxPdf_Document *pDocument, TPtxPdf_Permission *pPermissions)

PtxPdf_Metadata_GetCreatorW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCreatorW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The original application that created the document.

PtxPdf_Page_GetRotation
PDFTOOLS_TOOLBOX_EXPORT TPtxGeom_Rotation PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetRotation(TPtxPdf_Page *pPage)
The current page rotation.

PtxPdf_Page_Create
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Size *pSize)
Create an empty page The page is associated with the given target document but not yet part of it....

PtxPdf_Metadata_SetKeywordsA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetKeywordsA(TPtxPdf_Metadata *pMetadata, const char *szKeywords)
Keywords associated with the document or resource.

PtxPdf_Metadata_GetCreatorA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCreatorA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The original application that created the document.

PtxPdf_Document_GetOutputIntent
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_IccBasedColorSpace *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetOutputIntent(TPtxPdf_Document *pDocument)
the output intent of the document. The output intent specifies a color profile that characterizes the...

PtxPdf_PageCopyOptions_GetSignedSignatures
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_RemovalStrategy PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetSignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Removal strategy for signed signature fields.

PtxPdf_PageCopyOptions_SetNamedDestinations
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetNamedDestinations(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations)
Copy strategy for named destinations.

PtxPdf_Page_Rotate
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_Rotate(TPtxPdf_Page *pPage, TPtxGeom_Rotation iRotate)
Rotate the page by a multiple of 90 degrees.

PtxPdf_Encryption_GetOwnerPasswordW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetOwnerPasswordW(TPtxPdf_Encryption *pEncryption, WCHAR *pBuffer, size_t nBufferSize)

PtxPdf_Page_GetMetadata
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetMetadata(TPtxPdf_Page *pPage)
the metadata of the page.

PtxPdf_Metadata_GetProducerA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetProducerA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The application that created the PDF.

PtxPdf_PageCopyOptions_GetUnsignedSignatures
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetUnsignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for unsigned signature fields.

PtxPdf_OptionalContentGroupList_GetCount
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroupList_GetCount(TPtxPdf_OptionalContentGroupList *pOptionalContentGroupList)
Get the number of elements in the list.

PtxPdf_Document_IsLinearized
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_IsLinearized(TPtxPdf_Document *pDocument)

PtxPdf_Encryption_SetUserPasswordA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetUserPasswordA(TPtxPdf_Encryption *pEncryption, const char *szUserPassword)

PtxPdf_Document_GetLanguageW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetLanguageW(TPtxPdf_Document *pDocument, WCHAR *pBuffer, size_t nBufferSize)
the default language for the document. A language identifier specifying the natural language for all ...

PtxPdf_FileReference_SetAssociationRelationshipW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_SetAssociationRelationshipW(TPtxPdf_FileReference *pFileReference, const WCHAR *szAssociationRelationship)
The file's association relationship This property is NULL if the file is not associated with any obje...

PtxPdf_Metadata_GetTitleW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetTitleW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP m...

PtxPdf_Page_GetMediaBox
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetMediaBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pMediaBox)
The media box of the page.

PtxPdf_PageCopyOptions_SetFormFields
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetFormFields(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdfForms_FormFieldCopyStrategy iFormFields)
Copy strategy for form fields and widgets.

PtxPdf_Page_UpdateSize
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_UpdateSize(TPtxPdf_Page *pPage, const TPtxGeomReal_Rectangle *pRectangle)
Update the page size to a specified rectangle. Note that all page-related coordinates are normalized ...

PtxPdf_PageCopyOptions_SetSignedSignatures
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetSignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_RemovalStrategy iSignedSignatures)
Removal strategy for signed signature fields.

PtxPdf_Document_Close
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_Close(TPtxPdf_Document *pObject)
Close object.

PtxPdf_Metadata_GetSubjectW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetSubjectW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The subject of the document or resource. This property corresponds to the "dc:description" entry in t...

PtxPdf_Metadata_SetCreationDate
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetCreationDate(TPtxPdf_Metadata *pMetadata, const TPtxSys_Date *pCreationDate)
The date and time the document or resource was originally created. This property corresponds to the "...

PtxPdf_Metadata_SetCreatorA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetCreatorA(TPtxPdf_Metadata *pMetadata, const char *szCreator)
The original application that created the document.

PtxPdf_PageCopyOptions_GetCopyOutlineItems
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetCopyOutlineItems(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy outline items (bookmarks).

PtxPdf_Document_OpenW
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_OpenW(const TPtxSys_StreamDescriptor *pStreamDesc, const WCHAR *szPassword)
Open a PDF document. Documents opened with this method are read-only and cannot be modified.

PtxPdf_Metadata_GetKeywordsW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetKeywordsW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
Keywords associated with the document or resource.

PtxPdf_OptionalContentGroupList_Get
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_OptionalContentGroup *PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroupList_Get(TPtxPdf_OptionalContentGroupList *pOptionalContentGroupList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdf_Document_OpenWithFdfW
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_OpenWithFdfW(const TPtxSys_StreamDescriptor *pPdfStreamDesc, const TPtxSys_StreamDescriptor *pFdfStreamDesc, const WCHAR *szPassword)
Open a PDF document together with an FDF file. Documents opened with this method are read-only and ca...

PtxPdf_FileReference_GetDescriptionW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetDescriptionW(TPtxPdf_FileReference *pFileReference, WCHAR *pBuffer, size_t nBufferSize)
The file's description For embedded files, this is the description of the file presented to the user ...

PtxPdf_FileReference_Copy
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdf_FileReference *pFileReference)
Copy a file reference object Copy a file reference object from an input document to the given pTarget...

PtxPdf_FileReference_CreateW
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_CreateW(TPtxPdf_Document *pTargetDocument, const TPtxSys_StreamDescriptor *pData, const WCHAR *szName, const WCHAR *szMediaType, const WCHAR *szDescription, const TPtxSys_Date *pModificationDate)
Create a new file reference object The newly created file reference object belongs to the document bu...

PtxPdf_PageCopyOptions_SetFormFieldConflictResolution
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetFormFieldConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_NameConflictResolution iFormFieldConflictResolution)
Resolution of conflicting form field names.

PtxPdf_Document_GetOptionalContentGroups
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_OptionalContentGroupList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetOptionalContentGroups(TPtxPdf_Document *pDocument)
The optional content groups (layers) of the document.

PtxPdf_FileReference_GetMediaTypeA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetMediaTypeA(TPtxPdf_FileReference *pFileReference, char *pBuffer, size_t nBufferSize)
The file's MIME type.

PtxPdf_Metadata_SetAuthorW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetAuthorW(TPtxPdf_Metadata *pMetadata, const WCHAR *szAuthor)
The name of the person who created the document or resource. This property corresponds to the "dc:cre...

PtxPdf_PageCopyOptions_SetLinks
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetLinks(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_CopyStrategy iLinks)
Copy strategy for links.

PtxPdf_PageCopyOptions_GetNamedDestinations
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetNamedDestinations(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for named destinations.

PDFTOOLS_TOOLBOX_CALL
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_PtxPdf.h:26

PtxPdf_Encryption_GetUserPasswordA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetUserPasswordA(TPtxPdf_Encryption *pEncryption, char *pBuffer, size_t nBufferSize)

PtxPdf_PageList_GetCount
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_GetCount(TPtxPdf_PageList *pPageList)
Get the number of elements in the list.

PtxPdf_Document_GetLanguageA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetLanguageA(TPtxPdf_Document *pDocument, char *pBuffer, size_t nBufferSize)
the default language for the document. A language identifier specifying the natural language for all ...

PtxPdf_Metadata_GetSubjectA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetSubjectA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The subject of the document or resource. This property corresponds to the "dc:description" entry in t...

PtxPdf_Document_CreateWithFdf
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_CreateWithFdf(const TPtxSys_StreamDescriptor *pPdfStreamDesc, const TPtxSys_StreamDescriptor *pFdfStreamDesc, const TPtxPdf_Conformance *pConformance, TPtxPdf_Encryption *pEncryption)
Create a new PDF document and an associated FDF. Documents with created with this method are writable...

PtxPdf_Page_GetPageLabelA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetPageLabelA(TPtxPdf_Page *pPage, char *pBuffer, size_t nBufferSize)
Page label.

PtxPdf_PageCopyOptions_GetOptimizeResources
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetOptimizeResources(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Find and merge redundant resources.

PtxPdf_PageCopyOptions_SetCopyAssociatedFiles
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetCopyAssociatedFiles(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bCopyAssociatedFiles)
Copy associated files.

PtxPdf_OptionalContentGroup_GetNameA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroup_GetNameA(TPtxPdf_OptionalContentGroup *pOptionalContentGroup, char *pBuffer, size_t nBufferSize)

PtxPdf_PageCopyOptions_GetLinks
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetLinks(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for links.

PtxPdf_PageCopyOptions_New
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageCopyOptions *PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_New(void)

PtxPdf_Document_GetFormFields
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetFormFields(TPtxPdf_Document *pDocument)
The form fields of the document This list contains all AcroForm form fields that belong to this docum...

PtxPdf_Metadata_Create
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_Create(TPtxPdf_Document *pTargetDocument, const TPtxSys_StreamDescriptor *pXmp)
Create a new metadata object The newly created metadata object is associated with the target document...

PtxPdf_Page_GetAnnotations
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_AnnotationList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetAnnotations(TPtxPdf_Page *pPage)
the list of this page's annotations. Adding to this list results in an error:

PtxPdf_PageCopyOptions_GetFormFieldConflictResolution
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_NameConflictResolution PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetFormFieldConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Resolution of conflicting form field names.

PtxPdf_Encryption_SetOwnerPasswordW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetOwnerPasswordW(TPtxPdf_Encryption *pEncryption, const WCHAR *szOwnerPassword)

PtxPdf_FileReferenceList_GetCount
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReferenceList_GetCount(TPtxPdf_FileReferenceList *pFileReferenceList)
Get the number of elements in the list.

PtxPdf_Document_GetAllEmbeddedFiles
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReferenceList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetAllEmbeddedFiles(TPtxPdf_Document *pDocument)
plain embedded, associated, and attached files

PtxPdf_Metadata_GetXmp
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetXmp(TPtxPdf_Metadata *pMetadata, TPtxSys_StreamDescriptor *pOutStreamDesc)
The XMP metadata.

PtxPdf_PageCopyOptions_GetFormFields
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FormFieldCopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetFormFields(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for form fields and widgets.

PtxPdf_PageList_Get
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_Get(TPtxPdf_PageList *pPageList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdf_PageCopyOptions_SetOptimizeResources
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetOptimizeResources(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bOptimizeResources)
Find and merge redundant resources.

PtxPdf_Metadata_SetCreatorW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetCreatorW(TPtxPdf_Metadata *pMetadata, const WCHAR *szCreator)
The original application that created the document.

PtxPdf_Metadata_GetAuthorW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetAuthorW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The name of the person who created the document or resource. This property corresponds to the "dc:cre...

PtxPdf_Document_GetSignatureFields
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignatureFieldList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetSignatureFields(TPtxPdf_Document *pDocument)
The signature fields of the document Signature fields are a special kind of form fields,...

PtxPdf_Document_SetLanguageA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetLanguageA(TPtxPdf_Document *pDocument, const char *szLanguage)
the default language for the document. A language identifier specifying the natural language for all ...

PtxPdf_Document_OpenWithFdfA
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_OpenWithFdfA(const TPtxSys_StreamDescriptor *pPdfStreamDesc, const TPtxSys_StreamDescriptor *pFdfStreamDesc, const char *szPassword)
Open a PDF document together with an FDF file. Documents opened with this method are read-only and ca...

PtxPdf_Document_GetPlainEmbeddedFiles
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReferenceList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetPlainEmbeddedFiles(TPtxPdf_Document *pDocument)
plain embedded files

PtxPdf_Document_Create
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_Create(const TPtxSys_StreamDescriptor *pStreamDesc, const TPtxPdf_Conformance *pConformance, TPtxPdf_Encryption *pEncryption)
Create a new PDF document. Documents with created with this method are writable and can be modified.

PtxPdf_FileReference_GetModificationDate
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetModificationDate(TPtxPdf_FileReference *pFileReference, TPtxSys_Date *pModificationDate)
The file's date of last modification.

PtxPdf_PageCopyOptions_GetCopyAssociatedFiles
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetCopyAssociatedFiles(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy associated files.

PtxPdf_PageCopyOptions_GetCopyLogicalStructure
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetCopyLogicalStructure(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy the logical structure and tagging information.

PtxPdf_OptionalContentGroup_GetNameW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroup_GetNameW(TPtxPdf_OptionalContentGroup *pOptionalContentGroup, WCHAR *pBuffer, size_t nBufferSize)

PtxPdf_Document_GetViewerSettings
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetViewerSettings(TPtxPdf_Document *pDocument)

PtxPdf_Encryption_GetOwnerPasswordA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetOwnerPasswordA(TPtxPdf_Encryption *pEncryption, char *pBuffer, size_t nBufferSize)

PtxPdf_Document_SetMetadata
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetMetadata(TPtxPdf_Document *pDocument, TPtxPdf_Metadata *pMetadata)
the metadata of the document. If the document is writable, the metadata object will be writable too a...

PtxPdf_Page_GetContent
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Content *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetContent(TPtxPdf_Page *pPage)
the page content. If the page is writable, the content object can be used to apply new content on the...

PtxPdf_PageCopyOptions_GetOcgConflictResolution
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_NameConflictResolution PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetOcgConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions)

PtxPdf_Metadata_SetAuthorA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetAuthorA(TPtxPdf_Metadata *pMetadata, const char *szAuthor)
The name of the person who created the document or resource. This property corresponds to the "dc:cre...

PtxPdf_Metadata_Copy
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdf_Metadata *pMetadata)
Copy a metadata object Copy a metadata object from an input document to the given pTargetDocument....

PtxPdf_Document_GetMetadata
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetMetadata(TPtxPdf_Document *pDocument)
the metadata of the document. If the document is writable, the metadata object will be writable too a...

PtxPdf_OptionalContentGroup_GetState
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_OcgState PDFTOOLS_TOOLBOX_CALL PtxPdf_OptionalContentGroup_GetState(TPtxPdf_OptionalContentGroup *pOptionalContentGroup)

PtxPdf_Encryption_SetOwnerPasswordA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetOwnerPasswordA(TPtxPdf_Encryption *pEncryption, const char *szOwnerPassword)

PtxPdf_PageCopyOptions_SetCopyLogicalStructure
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetCopyLogicalStructure(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bCopyLogicalStructure)
Copy the logical structure and tagging information.

PtxPdf_PageList_GetRange
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageList *PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_GetRange(TPtxPdf_PageList *pPageList, int iIndex, int iCount)
Get range of elements.

PtxPdf_Encryption_SetUserPasswordW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetUserPasswordW(TPtxPdf_Encryption *pEncryption, const WCHAR *szUserPassword)

PtxPdf_Metadata_GetCreationDate
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetCreationDate(TPtxPdf_Metadata *pMetadata, TPtxSys_Date *pCreationDate)
The date and time the document or resource was originally created. This property corresponds to the "...

PtxPdf_Encryption_GetUserPasswordW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetUserPasswordW(TPtxPdf_Encryption *pEncryption, WCHAR *pBuffer, size_t nBufferSize)

PtxPdf_Document_GetAssociatedFiles
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReferenceList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetAssociatedFiles(TPtxPdf_Document *pDocument)
document-associated files

PtxPdf_PageList_Add
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_Add(TPtxPdf_PageList *pPageList, TPtxPdf_Page *pPage)
Add an element to the end of the list.

PtxPdf_Metadata_SetKeywordsW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetKeywordsW(TPtxPdf_Metadata *pMetadata, const WCHAR *szKeywords)
Keywords associated with the document or resource.

PtxPdf_Metadata_GetProducerW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetProducerW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The application that created the PDF.

PtxPdf_PageCopyOptions_SetOcgConflictResolution
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetOcgConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_NameConflictResolution iOcgConflictResolution)

PtxPdf_PageList_Copy
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageList *PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdf_PageList *pPageList, TPtxPdf_PageCopyOptions *pOptions)
Copy a page list Copy pages from an input document to the given pTargetDocument. The returned list is...

PtxPdf_FileReference_CreateA
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_CreateA(TPtxPdf_Document *pTargetDocument, const TPtxSys_StreamDescriptor *pData, const char *szName, const char *szMediaType, const char *szDescription, const TPtxSys_Date *pModificationDate)
Create a new file reference object The newly created file reference object belongs to the document bu...

PtxPdf_Metadata_GetAuthorA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetAuthorA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The name of the person who created the document or resource. This property corresponds to the "dc:cre...

PtxPdf_FileReference_GetNameA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetNameA(TPtxPdf_FileReference *pFileReference, char *pBuffer, size_t nBufferSize)
The file name For embedded files, this is the name presented to the user in a the list of embedded fi...

PtxPdf_Metadata_GetModificationDate
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_GetModificationDate(TPtxPdf_Metadata *pMetadata, TPtxSys_Date *pModificationDate)
The date and time the document or resource was most recently modified. This property corresponds to t...

PtxPdf_Page_SetMetadata
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_SetMetadata(TPtxPdf_Page *pPage, TPtxPdf_Metadata *pMetadata)
the metadata of the page.

PtxPdf_PageCopyOptions_GetAnnotations
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_GetAnnotations(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for annotations.

PtxPdf_Document_SetLanguageW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetLanguageW(TPtxPdf_Document *pDocument, const WCHAR *szLanguage)
the default language for the document. A language identifier specifying the natural language for all ...

PtxPdf_Metadata_SetSubjectA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetSubjectA(TPtxPdf_Metadata *pMetadata, const char *szSubject)
The subject of the document or resource. This property corresponds to the "dc:description" entry in t...

PtxPdf_FileReference_GetDescriptionA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetDescriptionA(TPtxPdf_FileReference *pFileReference, char *pBuffer, size_t nBufferSize)
The file's description For embedded files, this is the description of the file presented to the user ...

PtxPdf_FileReference_GetData
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetData(TPtxPdf_FileReference *pFileReference, TPtxSys_StreamDescriptor *pOutStreamDesc)
The file's stream.

PtxPdf_Metadata_SetSubjectW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetSubjectW(TPtxPdf_Metadata *pMetadata, const WCHAR *szSubject)
The subject of the document or resource. This property corresponds to the "dc:description" entry in t...

PtxPdf_FileReference_GetAssociationRelationshipA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetAssociationRelationshipA(TPtxPdf_FileReference *pFileReference, char *pBuffer, size_t nBufferSize)
The file's association relationship This property is NULL if the file is not associated with any obje...

PtxPdf_FileReferenceList_Get
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReferenceList_Get(TPtxPdf_FileReferenceList *pFileReferenceList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdf_PageCopyOptions_SetCopyOutlineItems
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageCopyOptions_SetCopyOutlineItems(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bCopyOutlineItems)
Copy outline items (bookmarks).

PtxPdf_Document_GetOpenDestination
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetOpenDestination(TPtxPdf_Document *pDocument)

PtxPdf_Metadata_SetTitleW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetTitleW(TPtxPdf_Metadata *pMetadata, const WCHAR *szTitle)
The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP m...

PtxPdf_Page_Copy
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, TPtxPdf_PageCopyOptions *pOptions)
Copy a page Copy a page object from an input document to the given pTargetDocument....

PtxPdf_Encryption_GetPermissions
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Permission PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_GetPermissions(TPtxPdf_Encryption *pEncryption)

PtxPdf_FileReference_GetNameW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_GetNameW(TPtxPdf_FileReference *pFileReference, WCHAR *pBuffer, size_t nBufferSize)
The file name For embedded files, this is the name presented to the user in a the list of embedded fi...

PtxPdf_FileReference_SetAssociationRelationshipA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReference_SetAssociationRelationshipA(TPtxPdf_FileReference *pFileReference, const char *szAssociationRelationship)
The file's association relationship This property is NULL if the file is not associated with any obje...

PtxPdf_Document_SetOpenDestination
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetOpenDestination(TPtxPdf_Document *pDocument, TPtxPdfNav_Destination *pOpenDestination)

PtxPdf_Document_SetOutputIntent
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_SetOutputIntent(TPtxPdf_Document *pDocument, TPtxPdfContent_IccBasedColorSpace *pOutputIntent)
the output intent of the document. The output intent specifies a color profile that characterizes the...

PtxPdf_FileReferenceList_Add
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_FileReferenceList_Add(TPtxPdf_FileReferenceList *pFileReferenceList, TPtxPdf_FileReference *pFileReference)
Add an element to the end of the list.

PtxPdf_Document_GetPages
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_PageList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Document_GetPages(TPtxPdf_Document *pDocument)
the pages of the document. If the document is writable, it is possible to append new pages to the end...

PtxPdf_Encryption_NewW
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Encryption *PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_NewW(const WCHAR *szUserPassword, const WCHAR *szOwnerPassword, TPtxPdf_Permission iPermissions)

PtxPdf_PageList_AddRange
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_PageList_AddRange(TPtxPdf_PageList *pPageList, TPtxPdf_PageList *pInput)
Add range of elements to th end of the list.

PtxPdf_Metadata_SetTitleA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Metadata_SetTitleA(TPtxPdf_Metadata *pMetadata, const char *szTitle)
The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP m...

PtxPdf_Encryption_SetPermissions
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdf_Encryption_SetPermissions(TPtxPdf_Encryption *pEncryption, TPtxPdf_Permission iPermissions)

PtxPdf_Page_GetLinks
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LinkList *PDFTOOLS_TOOLBOX_CALL PtxPdf_Page_GetLinks(TPtxPdf_Page *pPage)
the list of this page's links. Adding to this list results in an error:

PdfTools_Toolbox_PtxSys.h

PdfTools_Toolbox_Types.h

TPtxPdf_OcgState
TPtxPdf_OcgState
Definition PdfTools_Toolbox_Types.h:317

TPtxGeom_Rotation
TPtxGeom_Rotation
Definition PdfTools_Toolbox_Types.h:109

TPtxPdf_Permission
TPtxPdf_Permission
Definition PdfTools_Toolbox_Types.h:129

TPtxPdf_NameConflictResolution
TPtxPdf_NameConflictResolution
Definition PdfTools_Toolbox_Types.h:299

TPtxPdf_Conformance
TPtxPdf_Conformance
Definition PdfTools_Toolbox_Types.h:174

TPtxPdf_CopyStrategy
TPtxPdf_CopyStrategy
Definition PdfTools_Toolbox_Types.h:253

TPtxPdf_RemovalStrategy
TPtxPdf_RemovalStrategy
Definition PdfTools_Toolbox_Types.h:280

TPtxPdfNav_NamedDestinationCopyStrategy
TPtxPdfNav_NamedDestinationCopyStrategy
Definition PdfTools_Toolbox_Types.h:775

TPtxPdfForms_FormFieldCopyStrategy
TPtxPdfForms_FormFieldCopyStrategy
Definition PdfTools_Toolbox_Types.h:676

BOOL
#define BOOL
Definition PdfTools_Toolbox_Types.h:23

TPtx_StringMap

TPtxPdf_Document

TPtxPdf_Encryption

TPtxPdf_FileReference
Description of a file A file description is used for embedded files.

TPtxPdf_FileReferenceList

TPtxPdf_Metadata

TPtxPdf_OptionalContentGroup

TPtxPdf_OptionalContentGroupList

TPtxPdf_PageCopyOptions

TPtxPdf_Page

TPtxPdf_PageList

TPtxPdfAnnots_AnnotationList
A list of annotations When a list of PtxPdf_Page_GetAnnotations is obtained from a page that belongs ...

TPtxPdfContent_Content
Represents the content of a page or a group. The class has no methods on its own, but can be modified...

TPtxPdfContent_IccBasedColorSpace

TPtxPdfForms_FieldNodeMap

TPtxPdfForms_SignatureFieldList

TPtxPdfForms_WidgetList

TPtxPdfNav_Destination

TPtxPdfNav_LinkList

TPtxPdfNav_OutlineItemList

TPtxPdfNav_ViewerSettings

TPtxGeomReal_Rectangle
Definition PdfTools_Toolbox_Types.h:2139

TPtxGeomReal_Size
Definition PdfTools_Toolbox_Types.h:2125

TPtxSys_Date
Definition PdfTools_Toolbox_Types.h:2278

TPtxSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition PdfTools_Toolbox_PtxSys.h:49