document_assembler.h File Reference

The PDF Document Assembler API. More...

#include <pdfsdk/core.h>
#include <pdfsdk/graphics.h>

Go to the source code of this file.

Macros
#define	PDF_DOCASSEMBLER_API   PDFSDK_IMPORT_

Typedefs
typedef struct PDFDocumentAssemblerRec_ *	PDFDocumentAssembler
	The opaque handle to the PDFDocumentAssembler object.

Functions
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFDocumentAssemblerCreate (PDFDocumentAssembler *pAssembler)
	Creates a new PDFDocumentAssembler object.
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFDocumentAssemblerAddPages (PDFDocumentAssembler assembler, PDDoc sourceDoc, const PDPageRange *sourcePageIndices)
	Adds a document to the PDFDocumentAssembler object.
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFDocumentAssemblerAddImage (PDFDocumentAssembler assembler, GXBitmap bitmap)
	Adds an image to the PDFDocumentAssembler object.
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFDocumentAssemblerAddImageFromFile (PDFDocumentAssembler assembler, const wchar_t *filePath)
	Adds an image to the PDFDocumentAssembler object.
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFDocumentAssemblerAddImageFromMemory (PDFDocumentAssembler assembler, const void *data, size_t size)
	Adds an image to the PDFDocumentAssembler object.
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFDocumentAssemblerAssemble (PDFDocumentAssembler assembler, PDDoc *pResultDoc)
	Assembles the documents added to the PDFDocumentAssembler object.

Detailed Description

The PDF Document Assembler API.

The PDF Document Assembler API provides functionality to assemble PDF documents from multiple sources. The API allows you to add pages from existing documents and images to a new document. The resulting document can be saved to a file or used for further processing. The API is designed to be used in conjunction with the PDF SDK Core API.

Note

The API is available in the PDF Document Assembler Library.

Typedef Documentation

PDFDocumentAssembler

typedef struct PDFDocumentAssemblerRec_* PDFDocumentAssembler

The opaque handle to the PDFDocumentAssembler object.

Note

The object is reference-counted. Use PDHandleAcquire and PDHandleRelease to manage its lifetime.

Function Documentation

PDFDocumentAssemblerAddImage()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFDocumentAssemblerAddImage	(	PDFDocumentAssembler	assembler,
		GXBitmap	bitmap )

Adds an image to the PDFDocumentAssembler object.

Parameters

[in]	assembler	The PDFDocumentAssembler object.
[in]	bitmap	The image to add.

Returns

A PDErrCode error code.

PDFDocumentAssemblerAddImageFromFile()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFDocumentAssemblerAddImageFromFile	(	PDFDocumentAssembler	assembler,
		const wchar_t *	filePath )

Adds an image to the PDFDocumentAssembler object.

Parameters

[in]	assembler	The PDFDocumentAssembler object.
[in]	filePath	The path to the image file to add.

Returns

A PDErrCode error code.

PDFDocumentAssemblerAddImageFromMemory()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFDocumentAssemblerAddImageFromMemory	(	PDFDocumentAssembler	assembler,
		const void *	data,
		size_t	size )

Adds an image to the PDFDocumentAssembler object.

Parameters

[in]	assembler	The PDFDocumentAssembler object.
[in]	data	The image data.
[in]	size	The size of the image data.

Returns

A PDErrCode error code.

PDFDocumentAssemblerAddPages()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFDocumentAssemblerAddPages	(	PDFDocumentAssembler	assembler,
		PDDoc	sourceDoc,
		const PDPageRange *	sourcePageIndices )

Adds a document to the PDFDocumentAssembler object.

Parameters

[in]	assembler	The PDFDocumentAssembler object.
[in]	sourceDoc	The document to add.
[in]	sourcePageIndices	The page range to add. Pass NULL to add all pages.

Returns

A PDErrCode error code.

PDFDocumentAssemblerAssemble()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFDocumentAssemblerAssemble	(	PDFDocumentAssembler	assembler,
		PDDoc *	pResultDoc )

Assembles the documents added to the PDFDocumentAssembler object.

Parameters

[in]	assembler	The PDFDocumentAssembler object.
[out]	resultDoc	A pointer to a variable that will receive the assembled document.

Returns

A PDErrCode error code.

PDFDocumentAssemblerCreate()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFDocumentAssemblerCreate

(

PDFDocumentAssembler *

pAssembler

)

Creates a new PDFDocumentAssembler object.

Parameters

[out]

assembler

A pointer to a variable that will receive the new PDFDocumentAssembler object.

Returns

A PDErrCode error code.