IPageCollection_interface.h File Reference

Interface for IPageCollection wrapper. More...

Go to the source code of this file.

Functions
IPageCollection	IPageCollection_Create (PtrGetTypeFn ptrGetTypeFn, PtrGetAtFn ptrGetAtFn, PtrSetAtFn ptrSetAtFn, PtrAddTailFn ptrAddTailFn, PtrSetPageProcessedFn ptrSetPageProcessedFn, PtrGetPageProcessedFn ptrGetPageProcessedFn, idrs_exception *pargException)
	Creates a new IPageCollection object.
void	IPageCollection_Destroy (IPageCollection argIPageCollection, idrs_exception *pargException)
	Destroys a IPageCollection handle.
enum PageCollectionType	IPageCollection_GetType (const IPageCollection argIPageCollection, idrs_exception *pargException)
	GetType returns the type of this collection, either default or custom.
CPage	IPageCollection_GetAt (const IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	GetAt returns the page at the specified index.
void	IPageCollection_SetAt (IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, const CPage argPage, idrs_exception *pargException)
	Sets the page at the specified index in the collection.
void	IPageCollection_AddTail (IPageCollection argIPageCollection, const CPage argPage, idrs_exception *pargException)
	Adds the specified page after the one stored with the highest index in the collection.
void	IPageCollection_SetPageProcessed (IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, IDRS_BOOL const argValue, idrs_exception *pargException)
	Sets the flag that indicates whether the page at specified index has been processed by CDocumentWriter.
IDRS_BOOL	IPageCollection_GetPageProcessed (const IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	Reads the flag that indicates whether the page at specified index has been processed by CDocumentWriter.

Detailed Description

Interface for IPageCollection wrapper.

Function Documentation

IPageCollection_AddTail()

void IPageCollection_AddTail	(	IPageCollection	argIPageCollection,
		const CPage	argPage,
		idrs_exception *	pargException
	)

Adds the specified page after the one stored with the highest index in the collection.

Parameters

argIPageCollection	IPageCollection handle
argPage	The page object to insert
pargException	Pointer to exception structure that will be filled if an exception occurs

IPageCollection_Create()

IPageCollection IPageCollection_Create	(	PtrGetTypeFn	ptrGetTypeFn,
		PtrGetAtFn	ptrGetAtFn,
		PtrSetAtFn	ptrSetAtFn,
		PtrAddTailFn	ptrAddTailFn,
		PtrSetPageProcessedFn	ptrSetPageProcessedFn,
		PtrGetPageProcessedFn	ptrGetPageProcessedFn,
		idrs_exception *	pargException
	)

Creates a new IPageCollection object.

Parameters

ptrGetTypeFn	GetType function pointer
ptrGetAtFn	GetAt function pointer
ptrSetAtFn	SetAt function pointer
ptrAddTailFn	AddTail function pointer
ptrSetPageProcessedFn	SetPageProcessed function pointer
ptrGetPageProcessedFn	GetPageProcessed function pointer
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created IPageCollection

IPageCollection_Destroy()

void IPageCollection_Destroy	(	IPageCollection	argIPageCollection,
		idrs_exception *	pargException
	)

Destroys a IPageCollection handle.

Parameters

argIPageCollection	IPageCollection handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

IPageCollection_GetAt()

CPage IPageCollection_GetAt	(	const IPageCollection	argIPageCollection,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

GetAt returns the page at the specified index.

Parameters

argIPageCollection	IPageCollection handle
uiPageIndex	The index of the page to retrieve
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The CPage object if it exists, a null pointer otherwise

IPageCollection_GetPageProcessed()

IDRS_BOOL IPageCollection_GetPageProcessed	(	const IPageCollection	argIPageCollection,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

Reads the flag that indicates whether the page at specified index has been processed by CDocumentWriter.

Parameters

argIPageCollection	IPageCollection handle
uiPageIndex	The index of the page where to retrieve the PageProcessed flag.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The flag value.

IPageCollection_GetType()

enum PageCollectionType IPageCollection_GetType	(	const IPageCollection	argIPageCollection,
		idrs_exception *	pargException
	)

GetType returns the type of this collection, either default or custom.

Remarks

Integrator-defined page collections must return PageCollectionType::Custom

Returns

The collection type

Parameters

argIPageCollection	IPageCollection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

IPageCollection_SetAt()

void IPageCollection_SetAt	(	IPageCollection	argIPageCollection,
		IDRS_UINT const	uiPageIndex,
		const CPage	argPage,
		idrs_exception *	pargException
	)

Sets the page at the specified index in the collection.

Parameters

argIPageCollection	IPageCollection handle
uiPageIndex	The index of the page
argPage	The page object to put in the collection
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

If the the index is out of bounds, for instance greater than the highest index in the collection, the missing elements are filled-in with empty records.

IPageCollection_SetPageProcessed()

void IPageCollection_SetPageProcessed	(	IPageCollection	argIPageCollection,
		IDRS_UINT const	uiPageIndex,
		IDRS_BOOL const	argValue,
		idrs_exception *	pargException
	)

Sets the flag that indicates whether the page at specified index has been processed by CDocumentWriter.

Parameters

argIPageCollection	IPageCollection handle
uiPageIndex	The index of the page
argValue	The boolean flag value.
pargException	Pointer to exception structure that will be filled if an exception occurs