IDocumentSeparationCallback_interface.h File Reference

Interface for IDocumentSeparationCallback wrapper. More...

Go to the source code of this file.

Functions
IDocumentSeparationCallback	IDocumentSeparationCallback_Create (PtrSeparateDocumentFn ptrSeparateDocumentFn, idrs_exception *pargException)
	Creates a new IDocumentSeparationCallback object.
void	IDocumentSeparationCallback_Destroy (IDocumentSeparationCallback argIDocumentSeparationCallback, idrs_exception *pargException)
	Destroys a IDocumentSeparationCallback handle.
IDRS_BOOL	IDocumentSeparationCallback_SeparateDocument (IDocumentSeparationCallback argIDocumentSeparationCallback, IDRS_UINT64 const uiDocumentSizeWithoutCurrentPage, IDRS_UINT64 const uiDocumentSizeWithCurrentPage, IDRS_UINT const uiPageCount, idrs_exception *pargException)
	SeparateDocument callback method is automatically called by iDRS SDK for each page that is created by the document output engine, before it is added to the output document.

Detailed Description

Interface for IDocumentSeparationCallback wrapper.

Function Documentation

IDocumentSeparationCallback_Create()

IDocumentSeparationCallback IDocumentSeparationCallback_Create	(	PtrSeparateDocumentFn	ptrSeparateDocumentFn,
		idrs_exception *	pargException
	)

Creates a new IDocumentSeparationCallback object.

Parameters

ptrSeparateDocumentFn	SeparateDocument function pointer
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created IDocumentSeparationCallback

IDocumentSeparationCallback_Destroy()

void IDocumentSeparationCallback_Destroy	(	IDocumentSeparationCallback	argIDocumentSeparationCallback,
		idrs_exception *	pargException
	)

Destroys a IDocumentSeparationCallback handle.

Parameters

argIDocumentSeparationCallback	IDocumentSeparationCallback handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

IDocumentSeparationCallback_SeparateDocument()

IDRS_BOOL IDocumentSeparationCallback_SeparateDocument	(	IDocumentSeparationCallback	argIDocumentSeparationCallback,
		IDRS_UINT64 const	uiDocumentSizeWithoutCurrentPage,
		IDRS_UINT64 const	uiDocumentSizeWithCurrentPage,
		IDRS_UINT const	uiPageCount,
		idrs_exception *	pargException
	)

SeparateDocument callback method is automatically called by iDRS SDK for each page that is created by the document output engine, before it is added to the output document.

Parameters

argIDocumentSeparationCallback	IDocumentSeparationCallback handle
uiDocumentSizeWithoutCurrentPage	Size of the document without the current page added to it
uiDocumentSizeWithCurrentPage	Size of the document if the current page would be added to it
uiPageCount	Number of pages already added to the document (not including the current one)
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the current document should be separated without adding the current page. The current page will be added to the next document
IDRS_FALSE	if the current page should be added to the current document