CDefaultPageCollection_interface.h File Reference

Interface for CDefaultPageCollection wrapper. More...

Go to the source code of this file.

Functions
CDefaultPageCollection	CDefaultPageCollection_Create (const CIDRS argIDRS, IDRS_BOOL const bBlocking, idrs_exception *pargException)
	Creates a new CDefaultPageCollection object.
CDefaultPageCollection	CDefaultPageCollection_Create2 (const CIDRS argIDRS, idrs_exception *pargException)
	Creates a new CDefaultPageCollection object.
enum PageCollectionType	CDefaultPageCollection_GetType (const CDefaultPageCollection argCDefaultPageCollection, idrs_exception *pargException)
	GetType returns the type of this collection, either default or custom.
CPage	CDefaultPageCollection_GetAt (const CDefaultPageCollection argCDefaultPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	GetAt returns the page at the specified position.
void	CDefaultPageCollection_SetAt (CDefaultPageCollection argCDefaultPageCollection, IDRS_UINT const uiPageIndex, const CPage argPage, idrs_exception *pargException)
	Sets the page at the specified position.
void	CDefaultPageCollection_AddTail (CDefaultPageCollection argCDefaultPageCollection, const CPage argPage, idrs_exception *pargException)
	Adds the specified page after the one stored with the highest index in the collection.
void	CDefaultPageCollection_SetPageProcessed (CDefaultPageCollection argCDefaultPageCollection, IDRS_UINT const uiPageIndex, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the flag that indicates whether the page at specified index has been processed by CDocumentWriter.
void	CDefaultPageCollection_SetPageProcessed2 (CDefaultPageCollection argCDefaultPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	Sets the flag that indicates whether the page at specified index has been processed by CDocumentWriter.
IDRS_BOOL	CDefaultPageCollection_GetPageProcessed (const CDefaultPageCollection argCDefaultPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	Reads the flag that indicates whether the page at specified index has been processed by CDocumentWriter.
void	CDefaultPageCollection_SetStorageOptions (CDefaultPageCollection argCDefaultPageCollection, const CPageCollectionStorageOptions argStorageOptions, idrs_exception *pargException)
	Sets the storage options.
CPageCollectionStorageOptions	CDefaultPageCollection_GetStorageOptions (const CDefaultPageCollection argCDefaultPageCollection, idrs_exception *pargException)
	Gets the storage options.
void	CDefaultPageCollection_SetReadyToClose (CDefaultPageCollection argCDefaultPageCollection, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the flag that indicates whether the document's full set of pages is ready for the DocumentWriter.
IDRS_BOOL	CDefaultPageCollection_GetReadyToClose (const CDefaultPageCollection argCDefaultPageCollection, idrs_exception *pargException)
	Gets the flag that indicates whether the document's full set of pages is ready for the DocumentWriter.
void	CDefaultPageCollection_Destroy (CDefaultPageCollection argCDefaultPageCollection, idrs_exception *pargException)
	Destroys a CDefaultPageCollection handle.

Detailed Description

Interface for CDefaultPageCollection wrapper.

Function Documentation

CDefaultPageCollection_AddTail()

void CDefaultPageCollection_AddTail	(	CDefaultPageCollection	argCDefaultPageCollection,
		const CPage	argPage,
		idrs_exception *	pargException
	)

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

Parameters

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

CDefaultPageCollection_Create()

CDefaultPageCollection CDefaultPageCollection_Create	(	const CIDRS	argIDRS,
		IDRS_BOOL const	bBlocking,
		idrs_exception *	pargException
	)

Creates a new CDefaultPageCollection object.

Parameters

argIDRS	The CIDRS instance
bBlocking	If set to 'IDRS_TRUE', enables the blocking mode. Set to 'IDRS_FALSE' by default.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to IPageCollection methods

CDefaultPageCollection_Create2()

CDefaultPageCollection CDefaultPageCollection_Create2	(	const CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Creates a new CDefaultPageCollection object.

Parameters

argIDRS	The CIDRS instance
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to IPageCollection methods

CDefaultPageCollection_Destroy()

void CDefaultPageCollection_Destroy	(	CDefaultPageCollection	argCDefaultPageCollection,
		idrs_exception *	pargException
	)

Destroys a CDefaultPageCollection handle.

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_GetAt()

CPage CDefaultPageCollection_GetAt	(	const CDefaultPageCollection	argCDefaultPageCollection,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

GetAt returns the page at the specified position.

Parameters

argCDefaultPageCollection	CDefaultPageCollection 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

CDefaultPageCollection_GetPageProcessed()

IDRS_BOOL CDefaultPageCollection_GetPageProcessed	(	const CDefaultPageCollection	argCDefaultPageCollection,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

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

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
uiPageIndex	The index of the page
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The flag value.

CDefaultPageCollection_GetReadyToClose()

IDRS_BOOL CDefaultPageCollection_GetReadyToClose	(	const CDefaultPageCollection	argCDefaultPageCollection,
		idrs_exception *	pargException
	)

Gets the flag that indicates whether the document's full set of pages is ready for the DocumentWriter.

Returns

IDRS_TRUE if the collection contains all the pages of the document, IDRS_FALSE is the collection only contains a partial set.

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_GetStorageOptions()

CPageCollectionStorageOptions CDefaultPageCollection_GetStorageOptions	(	const CDefaultPageCollection	argCDefaultPageCollection,
		idrs_exception *	pargException
	)

Gets the storage options.

Returns

The storage options

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_GetType()

enum PageCollectionType CDefaultPageCollection_GetType	(	const CDefaultPageCollection	argCDefaultPageCollection,
		idrs_exception *	pargException
	)

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

Returns

The collection type

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_SetAt()

void CDefaultPageCollection_SetAt	(	CDefaultPageCollection	argCDefaultPageCollection,
		IDRS_UINT const	uiPageIndex,
		const CPage	argPage,
		idrs_exception *	pargException
	)

Sets the page at the specified position.

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
uiPageIndex	The index of the page
argPage	The page object
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.

CDefaultPageCollection_SetPageProcessed()

void CDefaultPageCollection_SetPageProcessed	(	CDefaultPageCollection	argCDefaultPageCollection,
		IDRS_UINT const	uiPageIndex,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

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

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
uiPageIndex	The index of the page
bValue	The boolean flag value.
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_SetPageProcessed2()

void CDefaultPageCollection_SetPageProcessed2	(	CDefaultPageCollection	argCDefaultPageCollection,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

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

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
uiPageIndex	The index of the page
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_SetReadyToClose()

void CDefaultPageCollection_SetReadyToClose	(	CDefaultPageCollection	argCDefaultPageCollection,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

Sets the flag that indicates whether the document's full set of pages is ready for the DocumentWriter.

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
bValue	The flag value
pargException	Pointer to exception structure that will be filled if an exception occurs

CDefaultPageCollection_SetStorageOptions()

void CDefaultPageCollection_SetStorageOptions	(	CDefaultPageCollection	argCDefaultPageCollection,
		const CPageCollectionStorageOptions	argStorageOptions,
		idrs_exception *	pargException
	)

Sets the storage options.

Parameters

argCDefaultPageCollection	CDefaultPageCollection handle
argStorageOptions	The storage options
pargException	Pointer to exception structure that will be filled if an exception occurs