Vanilla.PDF  1.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 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
33  VANILLAPDF_API error_type CALLING_CONVENTION Document_Open(string_type filename, DocumentHandle** result);
34 
38  VANILLAPDF_API error_type CALLING_CONVENTION Document_Create(string_type filename, DocumentHandle** result);
39 
43  VANILLAPDF_API error_type CALLING_CONVENTION Document_OpenFile(FileHandle* holder, DocumentHandle** result);
44 
48  VANILLAPDF_API error_type CALLING_CONVENTION Document_Save(DocumentHandle* handle, string_type filename);
49 
53  VANILLAPDF_API error_type CALLING_CONVENTION Document_SaveIncremental(DocumentHandle* handle, string_type filename);
54 
58  VANILLAPDF_API error_type CALLING_CONVENTION Document_GetCatalog(DocumentHandle* handle, CatalogHandle** result);
59 
63  VANILLAPDF_API error_type CALLING_CONVENTION Document_GetDocumentInfo(DocumentHandle* handle, DocumentInfoHandle** result);
64 
74  VANILLAPDF_API error_type CALLING_CONVENTION Document_AppendDocument(DocumentHandle* handle, DocumentHandle* source);
75 
79  VANILLAPDF_API error_type CALLING_CONVENTION Document_Sign(DocumentHandle* handle, FileHandle* destination, DocumentSignatureSettingsHandle* settings);
80 
85  VANILLAPDF_API error_type CALLING_CONVENTION Document_Release(DocumentHandle* handle);
86 
89 #ifdef __cplusplus
90 };
91 #endif
92 
93 #endif /* _C_DOCUMENT_H */
DocumentHandle::Document_AppendDocument
error_type Document_AppendDocument(DocumentHandle *handle, DocumentHandle *source)
Append another document's contents at the end of the file.
DocumentHandle::Document_GetCatalog
error_type Document_GetCatalog(DocumentHandle *handle, CatalogHandle **result)
Get document's catalog property.
DocumentInfoHandle
Metadata for the document.
DocumentHandle::Document_Release
error_type Document_Release(DocumentHandle *handle)
Decrement the internal reference counter.
DocumentHandle::Document_SaveIncremental
error_type Document_SaveIncremental(DocumentHandle *handle, string_type filename)
Save file state into new destination and create new section for all modifications done by user...
c_handles.h
This file contains all type forward declarations returned by the library API.
DocumentHandle::Document_Open
error_type Document_Open(string_type filename, DocumentHandle **result)
Opens a new document.
DocumentHandle::Document_Create
error_type Document_Create(string_type filename, DocumentHandle **result)
Creates a new document.
string_type
const char * string_type
C-Style string.
Definition: c_types.h:82
DocumentHandle::Document_GetDocumentInfo
error_type Document_GetDocumentInfo(DocumentHandle *handle, DocumentInfoHandle **result)
Get detailed document metadata.
DocumentHandle::Document_OpenFile
error_type Document_OpenFile(FileHandle *holder, DocumentHandle **result)
Opens a document using already existing file handle.
DocumentHandle::Document_Sign
error_type Document_Sign(DocumentHandle *handle, FileHandle *destination, DocumentSignatureSettingsHandle *settings)
Digitally signs the document using specified settings.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
DocumentHandle
Represents high-level file access handle.
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
DocumentSignatureSettingsHandle
Group of settings controlling document's digital signature.
DocumentHandle::Document_Save
error_type Document_Save(DocumentHandle *handle, string_type filename)
Save file state into new destination.
c_values.h
This file contains types and constants used as parameters or return values.
FileHandle
Represents low-level file access handle.
CatalogHandle
The root of a document's object hierarchy.