CXlsxOutputParams_interface.h File Reference

Interface for CXlsxOutputParams wrapper. More...

Go to the source code of this file.

Functions
CXlsxOutputParams	CXlsxOutputParams_Create (enum SpreadsheetLayout const evSpreadsheetLayout, idrs_exception *pargException)
	Create is instantiating a new instance of CXlsxOutputParams and associated data object.
enum SpreadsheetLayout	CXlsxOutputParams_GetSpreadsheetLayout (const CXlsxOutputParams argCXlsxOutputParams, idrs_exception *pargException)
	getter for the spreadsheet layout.
CJpegCompressionOptions	CXlsxOutputParams_GetJpegCompressionOptions (const CXlsxOutputParams argCXlsxOutputParams, idrs_exception *pargException)
	getter for the Jpeg Compression Options.
void	CXlsxOutputParams_SetJpegCompressionOptions (CXlsxOutputParams argCXlsxOutputParams, const CJpegCompressionOptions argJpegCompressionOptions, idrs_exception *pargException)
	setter for the Jpeg Compression Options property.
void	CXlsxOutputParams_Destroy (CXlsxOutputParams argCXlsxOutputParams, idrs_exception *pargException)
	Destroys a CXlsxOutputParams handle.

Detailed Description

Interface for CXlsxOutputParams wrapper.

Function Documentation

CXlsxOutputParams_Create()

CXlsxOutputParams CXlsxOutputParams_Create	(	enum SpreadsheetLayout const	evSpreadsheetLayout,
		idrs_exception *	pargException
	)

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

Parameters

evSpreadsheetLayout	spreadsheet layout type
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

New instance of CXlsxOutputParams

Remarks

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

CXlsxOutputParams_Destroy()

void CXlsxOutputParams_Destroy	(	CXlsxOutputParams	argCXlsxOutputParams,
		idrs_exception *	pargException
	)

Destroys a CXlsxOutputParams handle.

Parameters

argCXlsxOutputParams	CXlsxOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CXlsxOutputParams_GetJpegCompressionOptions()

CJpegCompressionOptions CXlsxOutputParams_GetJpegCompressionOptions	(	const CXlsxOutputParams	argCXlsxOutputParams,
		idrs_exception *	pargException
	)

getter for the Jpeg Compression Options.

Returns

the Jpeg compression options object

Parameters

argCXlsxOutputParams	CXlsxOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CXlsxOutputParams_GetSpreadsheetLayout()

enum SpreadsheetLayout CXlsxOutputParams_GetSpreadsheetLayout	(	const CXlsxOutputParams	argCXlsxOutputParams,
		idrs_exception *	pargException
	)

getter for the spreadsheet layout.

Returns

the spreadsheet layout type

Parameters

argCXlsxOutputParams	CXlsxOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CXlsxOutputParams_SetJpegCompressionOptions()

void CXlsxOutputParams_SetJpegCompressionOptions	(	CXlsxOutputParams	argCXlsxOutputParams,
		const CJpegCompressionOptions	argJpegCompressionOptions,
		idrs_exception *	pargException
	)

setter for the Jpeg Compression Options property.

Parameters

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