CHtmlOutputParams_interface.h File Reference

Interface for CHtmlOutputParams wrapper. More...

Go to the source code of this file.

Functions
CHtmlOutputParams	CHtmlOutputParams_Create (enum PageLayout const evPageLayout, idrs_exception *pargException)
	Create is instantiating a new instance of CHtmlOutputParams and associated data object.
enum PageLayout	CHtmlOutputParams_GetPageLayout (const CHtmlOutputParams argCHtmlOutputParams, idrs_exception *pargException)
	Get the page layout type.
CJpegCompressionOptions	CHtmlOutputParams_GetJpegCompressionOptions (const CHtmlOutputParams argCHtmlOutputParams, idrs_exception *pargException)
	Get the Jpeg Compression Options.
void	CHtmlOutputParams_SetJpegCompressionOptions (CHtmlOutputParams argCHtmlOutputParams, const CJpegCompressionOptions argJpegCompressionOptions, idrs_exception *pargException)
	Set the Jpeg Compression Options property.
void	CHtmlOutputParams_Destroy (CHtmlOutputParams argCHtmlOutputParams, idrs_exception *pargException)
	Destroys a CHtmlOutputParams handle.

Detailed Description

Interface for CHtmlOutputParams wrapper.

Function Documentation

CHtmlOutputParams_Create()

CHtmlOutputParams CHtmlOutputParams_Create	(	enum PageLayout const	evPageLayout,
		idrs_exception *	pargException
	)

Create is instantiating a new instance of CHtmlOutputParams and associated data object.

Parameters

evPageLayout	the page layout type.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

Limitation: Flowing and Editable layouts will provide the same output

Returns

New instance of CHtmlOutputParams

Remarks

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

CHtmlOutputParams_Destroy()

void CHtmlOutputParams_Destroy	(	CHtmlOutputParams	argCHtmlOutputParams,
		idrs_exception *	pargException
	)

Destroys a CHtmlOutputParams handle.

Parameters

argCHtmlOutputParams	CHtmlOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CHtmlOutputParams_GetJpegCompressionOptions()

CJpegCompressionOptions CHtmlOutputParams_GetJpegCompressionOptions	(	const CHtmlOutputParams	argCHtmlOutputParams,
		idrs_exception *	pargException
	)

Get the Jpeg Compression Options.

Returns

the Jpeg compression options object

Parameters

argCHtmlOutputParams	CHtmlOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CHtmlOutputParams_GetPageLayout()

enum PageLayout CHtmlOutputParams_GetPageLayout	(	const CHtmlOutputParams	argCHtmlOutputParams,
		idrs_exception *	pargException
	)

Get the page layout type.

Returns

the page layout type

Parameters

argCHtmlOutputParams	CHtmlOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CHtmlOutputParams_SetJpegCompressionOptions()

void CHtmlOutputParams_SetJpegCompressionOptions	(	CHtmlOutputParams	argCHtmlOutputParams,
		const CJpegCompressionOptions	argJpegCompressionOptions,
		idrs_exception *	pargException
	)

Set the Jpeg Compression Options property.

Parameters

argCHtmlOutputParams	CHtmlOutputParams handle
argJpegCompressionOptions	a Jpeg compression options object
pargException	Pointer to exception structure that will be filled if an exception occurs