PDF Toolbox
Loading...
Searching...
No Matches
PdfToolbox_PtxPdf.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfToolbox_PtxPdf.h
4 *
5 * Description: Sub Header file for PDF Toolbox API
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2015 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 *****************************************************************************/
13
14#ifndef PDFTOOLBOX_PTXPDF_H__
15#define PDFTOOLBOX_PTXPDF_H__
16
17#ifndef PDFTOOLBOX_CALL
18#if defined(WIN32)
19#define PDFTOOLBOX_CALL __stdcall
20#else
21#define PDFTOOLBOX_CALL
22#endif
23#endif
24
25#include "PdfToolbox_Types.h"
26#include "PdfToolbox_PtxSys.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#define PtxPdf_Encryption_New PtxPdf_Encryption_NewW
35#define PtxPdf_Encryption_GetUserPassword PtxPdf_Encryption_GetUserPasswordW
36#define PtxPdf_Encryption_SetUserPassword PtxPdf_Encryption_SetUserPasswordW
37#define PtxPdf_Encryption_GetOwnerPassword PtxPdf_Encryption_GetOwnerPasswordW
38#define PtxPdf_Encryption_SetOwnerPassword PtxPdf_Encryption_SetOwnerPasswordW
39
40#define PtxPdf_Document_Open PtxPdf_Document_OpenW
41#define PtxPdf_Document_OpenWithFdf PtxPdf_Document_OpenWithFdfW
42
43#define PtxPdf_Page_GetPageLabel PtxPdf_Page_GetPageLabelW
44
45#define PtxPdf_Metadata_GetTitle PtxPdf_Metadata_GetTitleW
46#define PtxPdf_Metadata_SetTitle PtxPdf_Metadata_SetTitleW
47#define PtxPdf_Metadata_GetAuthor PtxPdf_Metadata_GetAuthorW
48#define PtxPdf_Metadata_SetAuthor PtxPdf_Metadata_SetAuthorW
49#define PtxPdf_Metadata_GetSubject PtxPdf_Metadata_GetSubjectW
50#define PtxPdf_Metadata_SetSubject PtxPdf_Metadata_SetSubjectW
51#define PtxPdf_Metadata_GetKeywords PtxPdf_Metadata_GetKeywordsW
52#define PtxPdf_Metadata_SetKeywords PtxPdf_Metadata_SetKeywordsW
53#define PtxPdf_Metadata_GetCreator PtxPdf_Metadata_GetCreatorW
54#define PtxPdf_Metadata_SetCreator PtxPdf_Metadata_SetCreatorW
55#define PtxPdf_Metadata_GetProducer PtxPdf_Metadata_GetProducerW
56
57#define PtxPdf_FileReference_Create PtxPdf_FileReference_CreateW
58
59#define PtxPdf_FileReference_GetAssociationRelationship PtxPdf_FileReference_GetAssociationRelationshipW
60#define PtxPdf_FileReference_SetAssociationRelationship PtxPdf_FileReference_SetAssociationRelationshipW
61#define PtxPdf_FileReference_GetDescription PtxPdf_FileReference_GetDescriptionW
62
63#define PtxPdf_FileReference_GetMediaType PtxPdf_FileReference_GetMediaTypeW
64
65#define PtxPdf_FileReference_GetName PtxPdf_FileReference_GetNameW
66
67#else
68#define PtxPdf_Encryption_New PtxPdf_Encryption_NewA
69#define PtxPdf_Encryption_GetUserPassword PtxPdf_Encryption_GetUserPasswordA
70#define PtxPdf_Encryption_SetUserPassword PtxPdf_Encryption_SetUserPasswordA
71#define PtxPdf_Encryption_GetOwnerPassword PtxPdf_Encryption_GetOwnerPasswordA
72#define PtxPdf_Encryption_SetOwnerPassword PtxPdf_Encryption_SetOwnerPasswordA
73
74#define PtxPdf_Document_Open PtxPdf_Document_OpenA
75#define PtxPdf_Document_OpenWithFdf PtxPdf_Document_OpenWithFdfA
76
77#define PtxPdf_Page_GetPageLabel PtxPdf_Page_GetPageLabelA
78
79#define PtxPdf_Metadata_GetTitle PtxPdf_Metadata_GetTitleA
80#define PtxPdf_Metadata_SetTitle PtxPdf_Metadata_SetTitleA
81#define PtxPdf_Metadata_GetAuthor PtxPdf_Metadata_GetAuthorA
82#define PtxPdf_Metadata_SetAuthor PtxPdf_Metadata_SetAuthorA
83#define PtxPdf_Metadata_GetSubject PtxPdf_Metadata_GetSubjectA
84#define PtxPdf_Metadata_SetSubject PtxPdf_Metadata_SetSubjectA
85#define PtxPdf_Metadata_GetKeywords PtxPdf_Metadata_GetKeywordsA
86#define PtxPdf_Metadata_SetKeywords PtxPdf_Metadata_SetKeywordsA
87#define PtxPdf_Metadata_GetCreator PtxPdf_Metadata_GetCreatorA
88#define PtxPdf_Metadata_SetCreator PtxPdf_Metadata_SetCreatorA
89#define PtxPdf_Metadata_GetProducer PtxPdf_Metadata_GetProducerA
90
91#define PtxPdf_FileReference_Create PtxPdf_FileReference_CreateA
92
93#define PtxPdf_FileReference_GetAssociationRelationship PtxPdf_FileReference_GetAssociationRelationshipA
94#define PtxPdf_FileReference_SetAssociationRelationship PtxPdf_FileReference_SetAssociationRelationshipA
95#define PtxPdf_FileReference_GetDescription PtxPdf_FileReference_GetDescriptionA
96
97#define PtxPdf_FileReference_GetMediaType PtxPdf_FileReference_GetMediaTypeA
98
99#define PtxPdf_FileReference_GetName PtxPdf_FileReference_GetNameA
100
101#endif
102
103/******************************************************************************
104 * PageCopyOptions
105 *****************************************************************************/
115
155 TPtxPdf_CopyStrategy iLinks);
193 TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdfForms_FormFieldCopyStrategy iFormFields);
237 TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_RemovalStrategy iSignedSignatures);
275 TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_CopyStrategy iUnsignedSignatures);
319 TPtxPdf_CopyStrategy iAnnotations);
488 TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdf_NameConflictResolution iFormFieldConflictResolution);
504 pPageCopyOptions); // Deprecated in Version 3.3. Setting this property has no effect. When copying pages from
505 // multiple documents, layers (optional content groups, OCG) are always merged.
520 TPtxPdf_PageCopyOptions* pPageCopyOptions,
522 iOcgConflictResolution); // Deprecated in Version 3.3. Setting this property has no effect. When copying pages
523 // from multiple documents, layers (optional content groups, OCG) are always merged.
561 TPtxPdf_PageCopyOptions* pPageCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations);
607
608/******************************************************************************
609 * Encryption
610 *****************************************************************************/
624 const char* szOwnerPassword,
625 TPtxPdf_Permission iPermissions);
639 const WCHAR* szOwnerPassword,
640 TPtxPdf_Permission iPermissions);
641
661 char* pBuffer, size_t nBufferSize);
681 WCHAR* pBuffer, size_t nBufferSize);
694 const char* szUserPassword);
707 const WCHAR* szUserPassword);
727 char* pBuffer, size_t nBufferSize);
747 WCHAR* pBuffer, size_t nBufferSize);
760 const char* szOwnerPassword);
773 const WCHAR* szOwnerPassword);
798 TPtxPdf_Permission iPermissions);
799
800/******************************************************************************
801 * PageList
802 *****************************************************************************/
863 TPtxPdf_PageList* pPageList,
864 TPtxPdf_PageCopyOptions* pOptions);
911 int iCount);
946
947/******************************************************************************
948 * FileReferenceList
949 *****************************************************************************/
997 TPtxPdf_FileReference* pFileReference);
998
999/******************************************************************************
1000 * Document
1001 *****************************************************************************/
1033 const char* szPassword);
1065 const WCHAR* szPassword);
1101 const TPtxSys_StreamDescriptor* pFdfStreamDesc, const char* szPassword);
1137 const TPtxSys_StreamDescriptor* pFdfStreamDesc, const WCHAR* szPassword);
1172 const TPtxPdf_Conformance* pConformance,
1173 TPtxPdf_Encryption* pEncryption);
1217 const TPtxSys_StreamDescriptor* pPdfStreamDesc, const TPtxSys_StreamDescriptor* pFdfStreamDesc,
1218 const TPtxPdf_Conformance* pConformance, TPtxPdf_Encryption* pEncryption);
1219
1295 TPtxPdf_Metadata* pMetadata);
1577 TPtxPdfNav_Destination* pOpenDestination);
1598 TPtxPdf_Permission* pPermissions);
1642 TPtxPdfNav_ViewerSettings* pViewerSettings);
1666
1678/******************************************************************************
1679 * Page
1680 *****************************************************************************/
1704 const TPtxGeomReal_Size* pSize);
1765 TPtxPdf_PageCopyOptions* pOptions);
1790 const TPtxGeomReal_Rectangle* pRectangle);
1811
1821
2158 size_t nBufferSize);
2193 size_t nBufferSize);
2194
2195/******************************************************************************
2196 * Metadata
2197 *****************************************************************************/
2228 const TPtxSys_StreamDescriptor* pXmp);
2266 TPtxPdf_Metadata* pMetadata);
2267
2297 size_t nBufferSize);
2327 size_t nBufferSize);
2401 size_t nBufferSize);
2431 size_t nBufferSize);
2505 size_t nBufferSize);
2535 size_t nBufferSize);
2620 size_t nBufferSize);
2661 size_t nBufferSize);
2695 const char* szKeywords);
2729 const WCHAR* szKeywords);
2762 size_t nBufferSize);
2795 size_t nBufferSize);
2877 size_t nBufferSize);
2909 size_t nBufferSize);
2934 TPtxSys_Date* pCreationDate);
2957 const TPtxSys_Date* pCreationDate);
2982 TPtxSys_Date* pModificationDate);
3006 TPtxSys_StreamDescriptor* pOutStreamDesc);
3033
3034/******************************************************************************
3035 * FileReference
3036 *****************************************************************************/
3085 TPtxPdf_Document* pTargetDocument, const TPtxSys_StreamDescriptor* pData, const char* szName,
3086 const char* szMediaType, const char* szDescription, const TPtxSys_Date* pModificationDate);
3135 TPtxPdf_Document* pTargetDocument, const TPtxSys_StreamDescriptor* pData, const WCHAR* szName,
3136 const WCHAR* szMediaType, const WCHAR* szDescription, const TPtxSys_Date* pModificationDate);
3172
3228 TPtxPdf_FileReference* pFileReference, char* pBuffer, size_t nBufferSize);
3284 TPtxPdf_FileReference* pFileReference, WCHAR* pBuffer, size_t nBufferSize);
3333 TPtxPdf_FileReference* pFileReference, const char* szAssociationRelationship);
3382 TPtxPdf_FileReference* pFileReference, const WCHAR* szAssociationRelationship);
3409 char* pBuffer, size_t nBufferSize);
3436 WCHAR* pBuffer, size_t nBufferSize);
3460 char* pBuffer, size_t nBufferSize);
3484 WCHAR* pBuffer, size_t nBufferSize);
3503 TPtxSys_Date* pModificationDate);
3528 char* pBuffer, size_t nBufferSize);
3553 WCHAR* pBuffer, size_t nBufferSize);
3570 TPtxSys_StreamDescriptor* pOutStreamDesc);
3571
3572#ifdef __cplusplus
3573}
3574#endif
3575
3576#endif /* PDFTOOLBOX_PTXPDF_H__ */
unsigned short WCHAR
Definition PdfToolbox_Platform.h:90
#define PDFTOOLBOX_EXPORT
Definition PdfToolbox_Platform.h:138
PDFTOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLBOX_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....
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Metadata_GetCreatorA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The original application that created the document.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Encryption_GetOwnerPasswordA(TPtxPdf_Encryption *pEncryption, char *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetCopyOutlineItems(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy outline items (bookmarks).
#define PDFTOOLBOX_CALL
Definition PdfToolbox_PtxPdf.h:21
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_FileReference_GetModificationDate(TPtxPdf_FileReference *pFileReference, TPtxSys_Date *pModificationDate)
The file's date of last modification.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageList_Add(TPtxPdf_PageList *pPageList, TPtxPdf_Page *pPage)
Add an element to the end of the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_GetBleedBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pBleedBox)
The bleed box of the page.
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureFieldList *PDFTOOLBOX_CALL PtxPdf_Document_GetSignatureFields(TPtxPdf_Document *pDocument)
The signature fields of the document Signature fields are a special kind of form fields,...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Metadata_GetKeywordsA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
Keywords associated with the document or resource.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetOptimizeResources(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bOptimizeResources)
Find and merge redundant resources.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Metadata_SetCreatorW(TPtxPdf_Metadata *pMetadata, const WCHAR *szCreator)
The original application that created the document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetLinks(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_CopyStrategy iLinks)
Copy strategy for links.
PDFTOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Encryption_SetUserPasswordW(TPtxPdf_Encryption *pEncryption, const WCHAR *szUserPassword)
PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL PtxPdf_Document_GetOpenDestination(TPtxPdf_Document *pDocument)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_GetArtBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pArtBox)
The art box of the page.
PDFTOOLBOX_EXPORT TPtxPdf_FileReferenceList *PDFTOOLBOX_CALL PtxPdf_Document_GetPlainEmbeddedFiles(TPtxPdf_Document *pDocument)
plain embedded files
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_LinkList *PDFTOOLBOX_CALL PtxPdf_Page_GetLinks(TPtxPdf_Page *pPage)
the list of this page's links. Adding to this list results in an error:
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Encryption_GetUserPasswordW(TPtxPdf_Encryption *pEncryption, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Encryption_SetOwnerPasswordW(TPtxPdf_Encryption *pEncryption, const WCHAR *szOwnerPassword)
PDFTOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfForms_FormFieldCopyStrategy PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetFormFields(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for form fields and widgets.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdf_PageList_GetCount(TPtxPdf_PageList *pPageList)
Get the number of elements in the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_GetTrimBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pTrimBox)
The trim box of the page.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetNamedDestinations(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations)
Copy strategy for named destinations.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfContent_Content *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLBOX_CALL PtxPdf_Document_GetViewerSettings(TPtxPdf_Document *pDocument)
PDFTOOLBOX_EXPORT TPtxPdf_Conformance PDFTOOLBOX_CALL PtxPdf_Document_GetConformance(TPtxPdf_Document *pDocument)
the claimed conformance of the document. This method only returns the claimed conformance level,...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Document_GetPermissions(TPtxPdf_Document *pDocument, TPtxPdf_Permission *pPermissions)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Encryption_SetUserPasswordA(TPtxPdf_Encryption *pEncryption, const char *szUserPassword)
PDFTOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Metadata_GetProducerW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The application that created the PDF.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Document_IsLinearized(TPtxPdf_Document *pDocument)
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetNamedDestinations(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for named destinations.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetCopyAssociatedFiles(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bCopyAssociatedFiles)
Copy associated files.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetCopyAssociatedFiles(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy associated files.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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 ...
PDFTOOLBOX_EXPORT TPtxPdf_FileReferenceList *PDFTOOLBOX_CALL PtxPdf_Document_GetAssociatedFiles(TPtxPdf_Document *pDocument)
document-associated files
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Metadata_SetKeywordsW(TPtxPdf_Metadata *pMetadata, const WCHAR *szKeywords)
Keywords associated with the document or resource.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetFormFieldConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_NameConflictResolution iFormFieldConflictResolution)
Resolution of conflicting form field names.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Page_GetPageLabelW(TPtxPdf_Page *pPage, WCHAR *pBuffer, size_t nBufferSize)
Page label.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdf_FileReferenceList_GetCount(TPtxPdf_FileReferenceList *pFileReferenceList)
Get the number of elements in the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Encryption_SetPermissions(TPtxPdf_Encryption *pEncryption, TPtxPdf_Permission iPermissions)
PDFTOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLBOX_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....
PDFTOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_PageList *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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 ...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetCopyLogicalStructure(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bCopyLogicalStructure)
Copy the logical structure and tagging information.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Metadata_GetKeywordsW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
Keywords associated with the document or resource.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetCopyOutlineItems(TPtxPdf_PageCopyOptions *pPageCopyOptions, BOOL bCopyOutlineItems)
Copy outline items (bookmarks).
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfContent_IccBasedColorSpace *PDFTOOLBOX_CALL PtxPdf_Document_GetOutputIntent(TPtxPdf_Document *pDocument)
the output intent of the document. The output intent specifies a color profile that characterizes the...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Metadata_GetCreatorW(TPtxPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The original application that created the document.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_FileReference_GetMediaTypeW(TPtxPdf_FileReference *pFileReference, WCHAR *pBuffer, size_t nBufferSize)
The file's MIME type.
PDFTOOLBOX_EXPORT TPtxGeom_Rotation PDFTOOLBOX_CALL PtxPdf_Page_GetRotation(TPtxPdf_Page *pPage)
The current page rotation.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Metadata_GetProducerA(TPtxPdf_Metadata *pMetadata, char *pBuffer, size_t nBufferSize)
The application that created the PDF.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Page_GetPageLabelA(TPtxPdf_Page *pPage, char *pBuffer, size_t nBufferSize)
Page label.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetCopyLogicalStructure(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy the logical structure and tagging information.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Metadata_SetKeywordsA(TPtxPdf_Metadata *pMetadata, const char *szKeywords)
Keywords associated with the document or resource.
PDFTOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetUnsignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for unsigned signature fields.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Metadata_SetCreatorA(TPtxPdf_Metadata *pMetadata, const char *szCreator)
The original application that created the document.
PDFTOOLBOX_EXPORT TPtxPdf_Encryption *PDFTOOLBOX_CALL PtxPdf_Encryption_NewW(const WCHAR *szUserPassword, const WCHAR *szOwnerPassword, TPtxPdf_Permission iPermissions)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetFormFields(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdfForms_FormFieldCopyStrategy iFormFields)
Copy strategy for form fields and widgets.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_RemovalStrategy PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetSignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Removal strategy for signed signature fields.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Document_SetViewerSettings(TPtxPdf_Document *pDocument, TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Document_Close(TPtxPdf_Document *pObject)
Close object.
PDFTOOLBOX_EXPORT TPtxPdf_NameConflictResolution PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetOcgConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions)
PDFTOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetLinks(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for links.
PDFTOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_SetMetadata(TPtxPdf_Page *pPage, TPtxPdf_Metadata *pMetadata)
the metadata of the page.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_CopyStrategy PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetAnnotations(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Copy strategy for annotations.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLBOX_CALL PtxPdf_Document_GetOutline(TPtxPdf_Document *pDocument)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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 "...
PDFTOOLBOX_EXPORT TPtxPdf_Permission PDFTOOLBOX_CALL PtxPdf_Encryption_GetPermissions(TPtxPdf_Encryption *pEncryption)
PDFTOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_PageCopyOptions *PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_New(void)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdf_PageList *PDFTOOLBOX_CALL PtxPdf_PageList_GetRange(TPtxPdf_PageList *pPageList, int iIndex, int iCount)
Get range of elements.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Document_SetOpenDestination(TPtxPdf_Document *pDocument, TPtxPdfNav_Destination *pOpenDestination)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_FileReference_GetMediaTypeA(TPtxPdf_FileReference *pFileReference, char *pBuffer, size_t nBufferSize)
The file's MIME type.
PDFTOOLBOX_EXPORT TPtxPdf_Metadata *PDFTOOLBOX_CALL PtxPdf_Page_GetMetadata(TPtxPdf_Page *pPage)
the metadata of the page.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_GetSize(TPtxPdf_Page *pPage, TPtxGeomReal_Size *pSize)
the visible size of the page (crop box).
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_Rotate(TPtxPdf_Page *pPage, TPtxGeom_Rotation iRotate)
Rotate the page by a multiple of 90 degrees.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_FileReference_GetData(TPtxPdf_FileReference *pFileReference, TPtxSys_StreamDescriptor *pOutStreamDesc)
The file's stream.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetUnsignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_CopyStrategy iUnsignedSignatures)
Copy strategy for unsigned signature fields.
PDFTOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLBOX_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....
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Encryption_GetOwnerPasswordW(TPtxPdf_Encryption *pEncryption, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL PtxPdf_Page_GetWidgets(TPtxPdf_Page *pPage)
the list of this page's form field widgets. Adding to this list results in an error:
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetSignedSignatures(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_RemovalStrategy iSignedSignatures)
Removal strategy for signed signature fields.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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 ...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetOcgConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_NameConflictResolution iOcgConflictResolution)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Metadata_GetXmp(TPtxPdf_Metadata *pMetadata, TPtxSys_StreamDescriptor *pOutStreamDesc)
The XMP metadata.
PDFTOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLBOX_CALL PtxPdf_PageList_Get(TPtxPdf_PageList *pPageList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT TPtxPdf_Encryption *PDFTOOLBOX_CALL PtxPdf_Encryption_NewA(const char *szUserPassword, const char *szOwnerPassword, TPtxPdf_Permission iPermissions)
PDFTOOLBOX_EXPORT TPtxPdfAnnots_AnnotationList *PDFTOOLBOX_CALL PtxPdf_Page_GetAnnotations(TPtxPdf_Page *pPage)
the list of this page's annotations. Adding to this list results in an error:
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetOptimizeResources(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Find and merge redundant resources.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Page_GetMediaBox(TPtxPdf_Page *pPage, TPtxGeomReal_Rectangle *pMediaBox)
The media box of the page.
PDFTOOLBOX_EXPORT TPtxPdf_PageList *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageList_AddRange(TPtxPdf_PageList *pPageList, TPtxPdf_PageList *pInput)
Add range of elements to th end of the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_Encryption_SetOwnerPasswordA(TPtxPdf_Encryption *pEncryption, const char *szOwnerPassword)
PDFTOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLBOX_CALL PtxPdf_FileReferenceList_Get(TPtxPdf_FileReferenceList *pFileReferenceList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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 "...
PDFTOOLBOX_EXPORT TPtxPdf_Document *PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_SetAnnotations(TPtxPdf_PageCopyOptions *pPageCopyOptions, TPtxPdf_CopyStrategy iAnnotations)
Copy strategy for annotations.
PDFTOOLBOX_EXPORT TPtxPdf_FileReferenceList *PDFTOOLBOX_CALL PtxPdf_Document_GetAllEmbeddedFiles(TPtxPdf_Document *pDocument)
plain embedded, associated, and attached files
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdf_FileReferenceList_Add(TPtxPdf_FileReferenceList *pFileReferenceList, TPtxPdf_FileReference *pFileReference)
Add an element to the end of the list.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdf_Encryption_GetUserPasswordA(TPtxPdf_Encryption *pEncryption, char *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT TPtxPdf_NameConflictResolution PDFTOOLBOX_CALL PtxPdf_PageCopyOptions_GetFormFieldConflictResolution(TPtxPdf_PageCopyOptions *pPageCopyOptions)
Resolution of conflicting form field names.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtx_StringMap *PDFTOOLBOX_CALL PtxPdf_Metadata_GetCustomEntries(TPtxPdf_Metadata *pMetadata)
The custom entries in the document information dictionary.
TPtxGeom_Rotation
Definition PdfToolbox_Types.h:95
TPtxPdf_Permission
Definition PdfToolbox_Types.h:113
TPtxPdf_NameConflictResolution
Definition PdfToolbox_Types.h:267
TPtxPdf_Conformance
Definition PdfToolbox_Types.h:156
TPtxPdf_CopyStrategy
Definition PdfToolbox_Types.h:230
TPtxPdf_RemovalStrategy
Definition PdfToolbox_Types.h:251
TPtxPdfNav_NamedDestinationCopyStrategy
Definition PdfToolbox_Types.h:721
TPtxPdfForms_FormFieldCopyStrategy
Definition PdfToolbox_Types.h:622
#define BOOL
Definition PdfToolbox_Types.h:18
Description of a file A file description is used for embedded files.
A list of annotations When a list of PtxPdf_Page_GetAnnotations is obtained from a page that belongs ...
Represents the content of a page or a group. The class has no methods on its own, but can be modified...
Definition PdfToolbox_Types.h:1998
Definition PdfToolbox_Types.h:1984
Definition PdfToolbox_Types.h:2137
Structure that groups a set of callbacks that model streams.
Definition PdfToolbox_PtxSys.h:44