IProgressPageProcessing_interface.h File Reference

Interface for IProgressPageProcessing wrapper. More...

Go to the source code of this file.

Functions
IProgressPageProcessing	IProgressPageProcessing_Create (PtrOnPercentageUpdateFn ptrOnPercentageUpdateFn, PtrGetAbortFlagFn ptrGetAbortFlagFn, idrs_exception *pargException)
	Creates a new IProgressPageProcessing object.
void	IProgressPageProcessing_Destroy (IProgressPageProcessing argIProgressPageProcessing, idrs_exception *pargException)
	Destroys a IProgressPageProcessing handle.
void	IProgressPageProcessing_OnPercentageUpdate (IProgressPageProcessing argIProgressPageProcessing, IDRS_UINT const uiPercent, idrs_exception *pargException)
	OnPercentageUpdate must be overridden to monitor the processing progress.
IDRS_BOOL	IProgressPageProcessing_GetAbortFlag (IProgressPageProcessing argIProgressPageProcessing, idrs_exception *pargException)
	GetAbortFlag can be overridden so the current process will be stopped if returning IDRS_TRUE.

Detailed Description

Interface for IProgressPageProcessing wrapper.

Function Documentation

IProgressPageProcessing_Create()

IProgressPageProcessing IProgressPageProcessing_Create	(	PtrOnPercentageUpdateFn	ptrOnPercentageUpdateFn,
		PtrGetAbortFlagFn	ptrGetAbortFlagFn,
		idrs_exception *	pargException
	)

Creates a new IProgressPageProcessing object.

Parameters

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

Returns

The newly created IProgressPageProcessing

IProgressPageProcessing_Destroy()

void IProgressPageProcessing_Destroy	(	IProgressPageProcessing	argIProgressPageProcessing,
		idrs_exception *	pargException
	)

Destroys a IProgressPageProcessing handle.

Parameters

argIProgressPageProcessing	IProgressPageProcessing handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

IProgressPageProcessing_GetAbortFlag()

IDRS_BOOL IProgressPageProcessing_GetAbortFlag	(	IProgressPageProcessing	argIProgressPageProcessing,
		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

argIProgressPageProcessing	IProgressPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

IProgressPageProcessing_OnPercentageUpdate()

void IProgressPageProcessing_OnPercentageUpdate	(	IProgressPageProcessing	argIProgressPageProcessing,
		IDRS_UINT const	uiPercent,
		idrs_exception *	pargException
	)

OnPercentageUpdate must be overridden to monitor the processing progress.

Parameters

argIProgressPageProcessing	IProgressPageProcessing handle
uiPercent	The current progress, from 0 to 100.
pargException	Pointer to exception structure that will be filled if an exception occurs