CRtfOutputParams_interface.h File Reference

Interface for CRtfOutputParams wrapper. More...

Go to the source code of this file.

Functions
CRtfOutputParams	CRtfOutputParams_Create (enum PageLayout const evPageLayout, idrs_exception *pargException)
	Create is instantiating a new instance of CRtfOutputParams and associated data object.
enum PageLayout	CRtfOutputParams_GetPageLayout (const CRtfOutputParams argCRtfOutputParams, idrs_exception *pargException)
	Gets the page layout type.
CJpegCompressionOptions	CRtfOutputParams_GetJpegCompressionOptions (const CRtfOutputParams argCRtfOutputParams, idrs_exception *pargException)
	Gets the Jpeg Compression Options.
void	CRtfOutputParams_SetJpegCompressionOptions (CRtfOutputParams argCRtfOutputParams, const CJpegCompressionOptions argJpegCompressionOptions, idrs_exception *pargException)
	Sets for the Jpeg Compression Options property.
CPageSizeOptions	CRtfOutputParams_GetPageSizeOptions (const CRtfOutputParams argCRtfOutputParams, idrs_exception *pargException)
	Gets the page size options.
void	CRtfOutputParams_SetPageSizeOptions (CRtfOutputParams argCRtfOutputParams, const CPageSizeOptions argPageSizeOptions, idrs_exception *pargException)
	Sets the page size options.
void	CRtfOutputParams_Destroy (CRtfOutputParams argCRtfOutputParams, idrs_exception *pargException)
	Destroys a CRtfOutputParams handle.

Detailed Description

Interface for CRtfOutputParams wrapper.

Function Documentation

CRtfOutputParams_Create()

CRtfOutputParams CRtfOutputParams_Create	(	enum PageLayout const	evPageLayout,
		idrs_exception *	pargException
	)

Create is instantiating a new instance of CRtfOutputParams 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 CRtfOutputParams

Remarks

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

CRtfOutputParams_Destroy()

void CRtfOutputParams_Destroy	(	CRtfOutputParams	argCRtfOutputParams,
		idrs_exception *	pargException
	)

Destroys a CRtfOutputParams handle.

Parameters

argCRtfOutputParams	CRtfOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CRtfOutputParams_GetJpegCompressionOptions()

CJpegCompressionOptions CRtfOutputParams_GetJpegCompressionOptions	(	const CRtfOutputParams	argCRtfOutputParams,
		idrs_exception *	pargException
	)

Gets the Jpeg Compression Options.

Returns

the Jpeg compression options

Parameters

argCRtfOutputParams	CRtfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CRtfOutputParams_GetPageLayout()

enum PageLayout CRtfOutputParams_GetPageLayout	(	const CRtfOutputParams	argCRtfOutputParams,
		idrs_exception *	pargException
	)

Gets the page layout type.

Returns

the page layout type

Parameters

argCRtfOutputParams	CRtfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CRtfOutputParams_GetPageSizeOptions()

CPageSizeOptions CRtfOutputParams_GetPageSizeOptions	(	const CRtfOutputParams	argCRtfOutputParams,
		idrs_exception *	pargException
	)

Gets the page size options.

Returns

the page size options

Parameters

argCRtfOutputParams	CRtfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CRtfOutputParams_SetJpegCompressionOptions()

void CRtfOutputParams_SetJpegCompressionOptions	(	CRtfOutputParams	argCRtfOutputParams,
		const CJpegCompressionOptions	argJpegCompressionOptions,
		idrs_exception *	pargException
	)

Sets for the Jpeg Compression Options property.

Parameters

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

CRtfOutputParams_SetPageSizeOptions()

void CRtfOutputParams_SetPageSizeOptions	(	CRtfOutputParams	argCRtfOutputParams,
		const CPageSizeOptions	argPageSizeOptions,
		idrs_exception *	pargException
	)

Sets the page size options.

Parameters

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