IProgressDocumentWriting_interface.h File Reference

Interface for IProgressDocumentWriting wrapper. More...

Go to the source code of this file.

Functions
IProgressDocumentWriting	IProgressDocumentWriting_Create (PtrBeginPageProcessFn ptrBeginPageProcessFn, PtrGetAbortFlagFn2 ptrGetAbortFlagFn, idrs_exception *pargException)
	Creates a new IProgressDocumentWriting object.
void	IProgressDocumentWriting_Destroy (IProgressDocumentWriting argIProgressDocumentWriting, idrs_exception *pargException)
	Destroys a IProgressDocumentWriting handle.
void	IProgressDocumentWriting_BeginPageProcess (IProgressDocumentWriting argIProgressDocumentWriting, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	BeginPageProcess is called whenever iDRS DocumentOutput engine starts the conversion of a page.
IDRS_BOOL	IProgressDocumentWriting_GetAbortFlag (IProgressDocumentWriting argIProgressDocumentWriting, idrs_exception *pargException)
	GetAbortFlag can be overridden so the current process will be stopped if returning IDRS_TRUE.

Detailed Description

Interface for IProgressDocumentWriting wrapper.

Function Documentation

IProgressDocumentWriting_BeginPageProcess()

void IProgressDocumentWriting_BeginPageProcess	(	IProgressDocumentWriting	argIProgressDocumentWriting,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

BeginPageProcess is called whenever iDRS DocumentOutput engine starts the conversion of a page.

Parameters

argIProgressDocumentWriting	IProgressDocumentWriting handle
uiPageIndex	The index of the page that is being converted
pargException	Pointer to exception structure that will be filled if an exception occurs

IProgressDocumentWriting_Create()

IProgressDocumentWriting IProgressDocumentWriting_Create	(	PtrBeginPageProcessFn	ptrBeginPageProcessFn,
		PtrGetAbortFlagFn2	ptrGetAbortFlagFn,
		idrs_exception *	pargException
	)

Creates a new IProgressDocumentWriting object.

Parameters

ptrBeginPageProcessFn	BeginPageProcess function pointer
ptrGetAbortFlagFn	GetAbortFlag function pointer
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created IProgressDocumentWriting

IProgressDocumentWriting_Destroy()

void IProgressDocumentWriting_Destroy	(	IProgressDocumentWriting	argIProgressDocumentWriting,
		idrs_exception *	pargException
	)

Destroys a IProgressDocumentWriting handle.

Parameters

argIProgressDocumentWriting	IProgressDocumentWriting handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

IProgressDocumentWriting_GetAbortFlag()

IDRS_BOOL IProgressDocumentWriting_GetAbortFlag	(	IProgressDocumentWriting	argIProgressDocumentWriting,
		idrs_exception *	pargException
	)

GetAbortFlag can be overridden so the current process will be stopped if returning IDRS_TRUE.

Returns

IDRS_TRUE to abort, IDRS_FALSE to continue

Parameters

argIProgressDocumentWriting	IProgressDocumentWriting handle
pargException	Pointer to exception structure that will be filled if an exception occurs