attachments.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_ATTACHMENTS_H_INCLUDED_
#define PDFSDK_CORE_ATTACHMENTS_H_INCLUDED_
 
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/content.h>
#include <pdfsdk/core/document.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>
#include <pdfsdk/progress_monitor.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    kPDAttachmentOpAdd,
    kPDAttachmentOpRemove,
    kPDAttachmentOpUpdate
} PDAttachmentOperation;
 
typedef PDErrCode(PDFSDK_CALLCONV* PDAttachmentEnumProc)(const wchar_t* name, PDFileSpec fileSpec, void* clientData);
typedef void(PDFSDK_CALLCONV* PDAttachmentChangedProc)(const wchar_t* name, PDAttachmentOperation operation, void* clientData);
 
typedef bool(PDFSDK_CALLCONV* PDFileSpecOnNumericCIProc)(PDAtom key, double value, const wchar_t* prefix, void* clientData);
typedef bool(PDFSDK_CALLCONV* PDFileSpecOnStringCIProc)(PDAtom key, const wchar_t* value, const wchar_t* prefix, void* clientData);
typedef bool(PDFSDK_CALLCONV* PDFileSpecOnDateCIProc)(PDAtom key, const PDDateTime* value, const wchar_t* prefix, void* clientData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachAttachmentChangedCallback(PDDoc doc, PDAttachmentChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachAttachmentChangedCallback(PDDoc doc, PDAttachmentChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyAttachmentChanged(PDDoc doc, const wchar_t* name, PDAttachmentOperation operation);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetAttachment(PDDoc doc, const wchar_t* name, PDFileSpec* pFileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocEnumAttachments(PDDoc doc, PDAttachmentEnumProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAddAttachment(PDDoc doc, const wchar_t* name, PDFileSpec fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocRemoveAttachment(PDDoc doc, const wchar_t* name);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetNumAttachments(PDDoc doc, size_t* pNumAttachments);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachmentNameByIndex(PDDoc doc, size_t index, wchar_t* buffer, size_t bufsize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateEmbeddedFile(PDDoc doc, const wchar_t* path, PDFileSpec* pFileSpec);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecCreate(PDDoc doc, PDAtom fileSys, const wchar_t* path, PDFileSpec* pFileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecCreateFromPDObject(PDObject obj, PDFileSpec* pFileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetPDObject(PDFileSpec fileSpec, PDObject* pObject);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetFileSystem(PDFileSpec fileSpec, PDAtom fileSys);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetFileSystem(PDFileSpec fileSpec, PDAtom* pFileSys);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetPath(PDFileSpec fileSpec, const wchar_t* buffer, size_t bufSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetPath(PDFileSpec fileSpec, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetDesc(PDFileSpec fileSpec, const wchar_t* buffer, size_t bufSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetDesc(PDFileSpec fileSpec, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetCreateDate(PDFileSpec fileSpec, PDDateTime* pDateTime);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetModDate(PDFileSpec fileSpec, PDDateTime* pDateTime);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetFileSize(PDFileSpec fileSpec, int64_t* pFileSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetThumbnail(PDFileSpec fileSpec, PDDoc doc, PDEXObject* pThumb);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetThumbnail(PDFileSpec fileSpec, PDEXObject thumb);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSaveToFile(PDFileSpec fileSpec, const wchar_t* path);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetEncryptedPayload(PDDoc doc, const wchar_t* path, PDAtom filter, PDAtom version);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetEncryptedPayload(PDDoc doc, PDFileSpec* pFileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocRemoveEncryptedPayload(PDDoc doc);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDEncryptedPayloadGetEncryptionProps(PDFileSpec fileSpec, PDAtom* filter, PDAtom* version);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecRemoveCollectionItem(PDFileSpec fileSpec, PDAtom key);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecEnumCollectionItem(PDFileSpec fileSpec,
                                                                    const PDFileSpecOnNumericCIProc numProc,
                                                                    const PDFileSpecOnStringCIProc stringProc,
                                                                    const PDFileSpecOnDateCIProc dateProc,
                                                                    void* clientData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetNumericCollectionItemValue(PDFileSpec fileSpec,
                                                                               PDAtom key,
                                                                               double* value,
                                                                               wchar_t* prefix,
                                                                               size_t bufferSize,
                                                                               size_t* pSize);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetDateCollectionItemValue(PDFileSpec fileSpec,
                                                                            PDAtom key,
                                                                            PDDateTime* value,
                                                                            wchar_t* prefix,
                                                                            size_t bufferSize,
                                                                            size_t* pSize);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecGetTextCollectionItemValue(PDFileSpec fileSpec,
                                                                            PDAtom key,
                                                                            wchar_t* value,
                                                                            size_t valBufferSize,
                                                                            size_t* vSize,
                                                                            wchar_t* prefix,
                                                                            size_t bufferSize,
                                                                            size_t* pSize);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetNumericCollectionItemValue(PDFileSpec fileSpec,
                                                                               PDAtom key,
                                                                               double value,
                                                                               const wchar_t* prefix);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetDateCollectionItemValue(PDFileSpec fileSpec,
                                                                            PDAtom key,
                                                                            const PDDateTime* value,
                                                                            const wchar_t* prefix);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileSpecSetTextCollectionItemValue(PDFileSpec fileSpec,
                                                                            PDAtom key,
                                                                            const wchar_t* value,
                                                                            const wchar_t* prefix);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_ATTACHMENTS_H_INCLUDED_