Vanilla.PDF  1.5.3
Cross-platform toolkit for creating and modifying PDF documents
List of all members
DocumentHandle Class Reference

Represents high-level file access handle. More...

Inheritance diagram for DocumentHandle:
IUnknownHandle
error_type Document_Open (string_type filename, DocumentHandle **result)
 Opens a new document.
 
error_type Document_OpenFile (FileHandle *holder, DocumentHandle **result)
 Opens a document using already existing file handle.
 
error_type Document_Create (string_type filename, DocumentHandle **result)
 Creates a new document.
 
error_type Document_CreateFile (FileHandle *holder, DocumentHandle **result)
 Creates a new document.
 
error_type Document_Save (DocumentHandle *handle, string_type filename)
 Save file state into new destination. More...
 
error_type Document_SaveFile (DocumentHandle *handle, FileHandle *file_handle)
 Save file state into new destination. More...
 
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. More...
 
error_type Document_SaveIncrementalFile (DocumentHandle *handle, FileHandle *file_handle)
 Save file state into new destination and create new section for all modifications done by user. More...
 
error_type Document_GetCatalog (DocumentHandle *handle, CatalogHandle **result)
 Get document's catalog property.
 
error_type Document_GetDocumentInfo (DocumentHandle *handle, DocumentInfoHandle **result)
 Get detailed document metadata.
 
error_type Document_AppendDocument (DocumentHandle *handle, DocumentHandle *source)
 Append another document's contents at the end of the file. More...
 
error_type Document_Sign (DocumentHandle *handle, FileHandle *destination, DocumentSignatureSettingsHandle *settings)
 Digitally signs the document using specified settings.
 
error_type Document_ToUnknown (DocumentHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type Document_FromUnknown (IUnknownHandle *handle, DocumentHandle **result)
 Convert IUnknownHandle to DocumentHandle.
 
error_type Document_Release (DocumentHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Represents high-level file access handle.

Examples:
extract.c, merge.c, sign.c, and sign_custom.c.

Friends And Related Function Documentation

◆ Document_Save()

error_type Document_Save ( DocumentHandle handle,
string_type  filename 
)
related

Save file state into new destination.

Destination file will be overwritten if it exists.

Examples:
merge.c.

◆ Document_SaveFile()

error_type Document_SaveFile ( DocumentHandle handle,
FileHandle file_handle 
)
related

Save file state into new destination.

Destination file will be overwritten if it exists.

◆ Document_SaveIncremental()

error_type Document_SaveIncremental ( DocumentHandle handle,
string_type  filename 
)
related

Save file state into new destination and create new section for all modifications done by user.

This method creates a new section with all modified objects. Whole file content preceeding new section will be preserved.

◆ Document_SaveIncrementalFile()

error_type Document_SaveIncrementalFile ( DocumentHandle handle,
FileHandle file_handle 
)
related

Save file state into new destination and create new section for all modifications done by user.

This method creates a new section with all modified objects. Whole file content preceeding new section will be preserved.

◆ Document_AppendDocument()

error_type Document_AppendDocument ( DocumentHandle handle,
DocumentHandle source 
)
related

Append another document's contents at the end of the file.

This appends all source document's pages beyond handle document's pages.

After pages are merged, all indirect referenced are resolved so they point to correct objects.

The last step fixes link annotations, which can be referenced by page number.

Examples:
merge.c.

◆ Document_Release()

error_type Document_Release ( DocumentHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release
Examples:
extract.c, merge.c, sign.c, and sign_custom.c.

The documentation for this class was generated from the following file: