COdtOutputParams_interface.h File Reference

Interface for COdtOutputParams wrapper. More...

Go to the source code of this file.

Functions
COdtOutputParams	COdtOutputParams_Create (enum PageLayout const evPageLayout, idrs_exception *pargException)
	Create is instantiating a new instance of COdtOutputParams and associated data object.
enum PageLayout	COdtOutputParams_GetPageLayout (const COdtOutputParams argCOdtOutputParams, idrs_exception *pargException)
	getter for the page layout type.
CJpegCompressionOptions	COdtOutputParams_GetJpegCompressionOptions (const COdtOutputParams argCOdtOutputParams, idrs_exception *pargException)
	Gets the Jpeg Compression Options.
void	COdtOutputParams_SetJpegCompressionOptions (COdtOutputParams argCOdtOutputParams, const CJpegCompressionOptions argJpegCompressionOptions, idrs_exception *pargException)
	Sets the Jpeg Compression Options property.
CPageSizeOptions	COdtOutputParams_GetPageSizeOptions (const COdtOutputParams argCOdtOutputParams, idrs_exception *pargException)
	Gets the page size options.
void	COdtOutputParams_SetPageSizeOptions (COdtOutputParams argCOdtOutputParams, const CPageSizeOptions argPageSizeOptions, idrs_exception *pargException)
	Sets the page size options.
void	COdtOutputParams_Destroy (COdtOutputParams argCOdtOutputParams, idrs_exception *pargException)
	Destroys a COdtOutputParams handle.

Detailed Description

Interface for COdtOutputParams wrapper.

Function Documentation

COdtOutputParams_Create()

COdtOutputParams COdtOutputParams_Create	(	enum PageLayout const	evPageLayout,
		idrs_exception *	pargException
	)

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

Parameters

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

Returns

New instance of COdtOutputParams

Remarks

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

COdtOutputParams_Destroy()

void COdtOutputParams_Destroy	(	COdtOutputParams	argCOdtOutputParams,
		idrs_exception *	pargException
	)

Destroys a COdtOutputParams handle.

Parameters

argCOdtOutputParams	COdtOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

COdtOutputParams_GetJpegCompressionOptions()

CJpegCompressionOptions COdtOutputParams_GetJpegCompressionOptions	(	const COdtOutputParams	argCOdtOutputParams,
		idrs_exception *	pargException
	)

Gets the Jpeg Compression Options.

Returns

the Jpeg compression options object

Parameters

argCOdtOutputParams	COdtOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COdtOutputParams_GetPageLayout()

enum PageLayout COdtOutputParams_GetPageLayout	(	const COdtOutputParams	argCOdtOutputParams,
		idrs_exception *	pargException
	)

getter for the page layout type.

Returns

the page layout type

Parameters

argCOdtOutputParams	COdtOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COdtOutputParams_GetPageSizeOptions()

CPageSizeOptions COdtOutputParams_GetPageSizeOptions	(	const COdtOutputParams	argCOdtOutputParams,
		idrs_exception *	pargException
	)

Gets the page size options.

Returns

the page size options

Parameters

argCOdtOutputParams	COdtOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COdtOutputParams_SetJpegCompressionOptions()

void COdtOutputParams_SetJpegCompressionOptions	(	COdtOutputParams	argCOdtOutputParams,
		const CJpegCompressionOptions	argJpegCompressionOptions,
		idrs_exception *	pargException
	)

Sets the Jpeg Compression Options property.

Parameters

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

COdtOutputParams_SetPageSizeOptions()

void COdtOutputParams_SetPageSizeOptions	(	COdtOutputParams	argCOdtOutputParams,
		const CPageSizeOptions	argPageSizeOptions,
		idrs_exception *	pargException
	)

Sets the page size options.

Parameters

argCOdtOutputParams	COdtOutputParams handle
argPageSizeOptions	the page size options
pargException	Pointer to exception structure that will be filled if an exception occurs