This documentation is deprecated and will no longer be updated. Please use the official documentation at vanillapdf.readthedocs.io.
Vanilla.PDF  2.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_document.h
Go to the documentation of this file.
1#ifndef _C_DOCUMENT_H
2#define _C_DOCUMENT_H
3
4#include "vanillapdf/c_export.h"
5#include "vanillapdf/c_handles.h"
6#include "vanillapdf/c_values.h"
7
8#include "vanillapdf/utils/c_io_strategy.h"
9
10#ifdef __cplusplus
11extern "C"
12{
13#endif
14
35 VANILLAPDF_API error_type CALLING_CONVENTION Document_Open(string_type filename, DocumentHandle** result);
36
41 VANILLAPDF_API error_type CALLING_CONVENTION Document_OpenWithStrategy(string_type filename, IOStrategyType strategy, DocumentHandle** result);
42
46 VANILLAPDF_API error_type CALLING_CONVENTION Document_OpenFile(FileHandle* holder, DocumentHandle** result);
47
51 VANILLAPDF_API error_type CALLING_CONVENTION Document_Create(string_type filename, DocumentHandle** result);
52
57 VANILLAPDF_API error_type CALLING_CONVENTION Document_CreateWithStrategy(string_type filename, IOStrategyType strategy, DocumentHandle** result);
58
62 VANILLAPDF_API error_type CALLING_CONVENTION Document_CreateFile(FileHandle* holder, DocumentHandle** result);
63
67 VANILLAPDF_API error_type CALLING_CONVENTION Document_Save(DocumentHandle* handle, string_type filename);
68
72 VANILLAPDF_API error_type CALLING_CONVENTION Document_SaveFile(DocumentHandle* handle, FileHandle* file_handle);
73
77 VANILLAPDF_API error_type CALLING_CONVENTION Document_SaveIncremental(DocumentHandle* handle, string_type filename);
78
82 VANILLAPDF_API error_type CALLING_CONVENTION Document_SaveIncrementalFile(DocumentHandle* handle, FileHandle* file_handle);
83
87 VANILLAPDF_API error_type CALLING_CONVENTION Document_GetCatalog(DocumentHandle* handle, CatalogHandle** result);
88
92 VANILLAPDF_API error_type CALLING_CONVENTION Document_GetDocumentInfo(DocumentHandle* handle, DocumentInfoHandle** result);
93
103 VANILLAPDF_API error_type CALLING_CONVENTION Document_AppendDocument(DocumentHandle* handle, DocumentHandle* source);
104
108 VANILLAPDF_API error_type CALLING_CONVENTION Document_Sign(DocumentHandle* handle, FileHandle* destination, DocumentSignatureSettingsHandle* settings);
109
113 VANILLAPDF_API error_type CALLING_CONVENTION Document_AddEncryption(DocumentHandle* handle, DocumentEncryptionSettingsHandle* settings);
114
122 VANILLAPDF_API error_type CALLING_CONVENTION Document_RemoveEncryption(DocumentHandle* handle);
123
127 VANILLAPDF_API error_type CALLING_CONVENTION Document_ToUnknown(DocumentHandle* handle, IUnknownHandle** result);
128
132 VANILLAPDF_API error_type CALLING_CONVENTION Document_FromUnknown(IUnknownHandle* handle, DocumentHandle** result);
133
138 VANILLAPDF_API error_type CALLING_CONVENTION Document_Release(DocumentHandle* handle);
139
142#ifdef __cplusplus
143};
144#endif
145
146#endif /* _C_DOCUMENT_H */
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.
c_handles.h
This file contains all type forward declarations returned by the library API.
c_io_strategy.h
This file contains definitions for IOStrategyType.
c_values.h
This file contains types and constants used as parameters or return values.
CatalogHandle
The root of a document's object hierarchy.
DocumentEncryptionSettingsHandle
Group of settings controlling document's encryption and decryption.
DocumentHandle
Represents high-level file access handle.
DocumentHandle::Document_CreateWithStrategy
error_type CALLING_CONVENTION Document_CreateWithStrategy(string_type filename, IOStrategyType strategy, DocumentHandle **result)
Creates a new document using the specified I/O strategy.
DocumentHandle::Document_FromUnknown
error_type CALLING_CONVENTION Document_FromUnknown(IUnknownHandle *handle, DocumentHandle **result)
Convert IUnknownHandle to DocumentHandle.
DocumentHandle::Document_ToUnknown
error_type CALLING_CONVENTION Document_ToUnknown(DocumentHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
DocumentHandle::Document_GetCatalog
error_type CALLING_CONVENTION Document_GetCatalog(DocumentHandle *handle, CatalogHandle **result)
Get document's catalog property.
DocumentHandle::Document_RemoveEncryption
error_type CALLING_CONVENTION Document_RemoveEncryption(DocumentHandle *handle)
Remove any existing encryption from the document.
DocumentHandle::Document_SaveIncrementalFile
error_type CALLING_CONVENTION Document_SaveIncrementalFile(DocumentHandle *handle, FileHandle *file_handle)
Save file state into new destination and create new section for all modifications done by user.
DocumentHandle::Document_GetDocumentInfo
error_type CALLING_CONVENTION Document_GetDocumentInfo(DocumentHandle *handle, DocumentInfoHandle **result)
Get detailed document metadata.
DocumentHandle::Document_OpenFile
error_type CALLING_CONVENTION Document_OpenFile(FileHandle *holder, DocumentHandle **result)
Opens a document using already existing file handle.
DocumentHandle::Document_AddEncryption
error_type CALLING_CONVENTION Document_AddEncryption(DocumentHandle *handle, DocumentEncryptionSettingsHandle *settings)
Encrypt the document using the specified settings.
DocumentHandle::Document_Save
error_type CALLING_CONVENTION Document_Save(DocumentHandle *handle, string_type filename)
Save file state into new destination.
DocumentHandle::Document_AppendDocument
error_type CALLING_CONVENTION Document_AppendDocument(DocumentHandle *handle, DocumentHandle *source)
Append another document's contents at the end of the file.
DocumentHandle::Document_SaveFile
error_type CALLING_CONVENTION Document_SaveFile(DocumentHandle *handle, FileHandle *file_handle)
Save file state into new destination.
DocumentHandle::Document_SaveIncremental
error_type CALLING_CONVENTION Document_SaveIncremental(DocumentHandle *handle, string_type filename)
Save file state into new destination and create new section for all modifications done by user.
DocumentHandle::Document_CreateFile
error_type CALLING_CONVENTION Document_CreateFile(FileHandle *holder, DocumentHandle **result)
Creates a new document.
DocumentHandle::Document_Release
error_type CALLING_CONVENTION Document_Release(DocumentHandle *handle)
Decrement the internal reference counter.
DocumentHandle::Document_Open
error_type CALLING_CONVENTION Document_Open(string_type filename, DocumentHandle **result)
Opens a new document.
DocumentHandle::Document_Create
error_type CALLING_CONVENTION Document_Create(string_type filename, DocumentHandle **result)
Creates a new document.
DocumentHandle::Document_Sign
error_type CALLING_CONVENTION Document_Sign(DocumentHandle *handle, FileHandle *destination, DocumentSignatureSettingsHandle *settings)
Digitally signs the document using specified settings.
DocumentHandle::Document_OpenWithStrategy
error_type CALLING_CONVENTION Document_OpenWithStrategy(string_type filename, IOStrategyType strategy, DocumentHandle **result)
Opens a new document using the specified I/O strategy.
DocumentInfoHandle
Metadata for the document.
DocumentSignatureSettingsHandle
Group of settings controlling document's digital signature.
FileHandle
Represents low-level file access handle.
IUnknownHandle
Base class for reference counting.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
string_type
const char * string_type
C-Style string.
Definition c_types.h:82
IOStrategyType
IOStrategyType
Specifies the I/O strategy used for file access.
Definition c_io_strategy.h:28