CPdfCompressionOptions_interface.h File Reference

Interface for CPdfCompressionOptions wrapper. More...

Go to the source code of this file.

Functions
CPdfCompressionOptions	CPdfCompressionOptions_Create (idrs_exception *pargException)
	Create is instantiating a new instance of CPdfCompressionOptions and associated data object.
void	CPdfCompressionOptions_SetCompressionQuality (CPdfCompressionOptions argCPdfCompressionOptions, enum CompressionQuality const evCompressionQuality, idrs_exception *pargException)
	Sets the pdf compression quality.
enum CompressionQuality	CPdfCompressionOptions_GetCompressionQuality (const CPdfCompressionOptions argCPdfCompressionOptions, idrs_exception *pargException)
	Gets the pdf compression quality.
void	CPdfCompressionOptions_SetBitonalFormat (CPdfCompressionOptions argCPdfCompressionOptions, enum ImageFormat const evBitonalFormat, idrs_exception *pargException)
	Sets the Bitonal file format. This compression format will be used when input is black and white, or for the mask layer if PDF PageDisplay is set to HyperCompressed.
enum ImageFormat	CPdfCompressionOptions_GetBitonalFormat (const CPdfCompressionOptions argCPdfCompressionOptions, idrs_exception *pargException)
	Gets the Bitonal file format.
void	CPdfCompressionOptions_SetColorFormat (CPdfCompressionOptions argCPdfCompressionOptions, enum ImageFormat const evColorFormat, idrs_exception *pargException)
	Sets the Color file format. This compression format will be used when when input is color or grayscale.
enum ImageFormat	CPdfCompressionOptions_GetColorFormat (const CPdfCompressionOptions argCPdfCompressionOptions, idrs_exception *pargException)
	Gets the Color file format.
void	CPdfCompressionOptions_Destroy (CPdfCompressionOptions argCPdfCompressionOptions, idrs_exception *pargException)
	Destroys a CPdfCompressionOptions handle.

Detailed Description

Interface for CPdfCompressionOptions wrapper.

Function Documentation

CPdfCompressionOptions_Create()

CPdfCompressionOptions CPdfCompressionOptions_Create

(

idrs_exception *

pargException

)

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

Returns

New instance of CPdfCompressionOptions

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_Destroy()

void CPdfCompressionOptions_Destroy	(	CPdfCompressionOptions	argCPdfCompressionOptions,
		idrs_exception *	pargException
	)

Destroys a CPdfCompressionOptions handle.

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_GetBitonalFormat()

enum ImageFormat CPdfCompressionOptions_GetBitonalFormat	(	const CPdfCompressionOptions	argCPdfCompressionOptions,
		idrs_exception *	pargException
	)

Gets the Bitonal file format.

Returns

the Bitonal file format.

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_GetColorFormat()

enum ImageFormat CPdfCompressionOptions_GetColorFormat	(	const CPdfCompressionOptions	argCPdfCompressionOptions,
		idrs_exception *	pargException
	)

Gets the Color file format.

Returns

the Color file format.

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_GetCompressionQuality()

enum CompressionQuality CPdfCompressionOptions_GetCompressionQuality	(	const CPdfCompressionOptions	argCPdfCompressionOptions,
		idrs_exception *	pargException
	)

Gets the pdf compression quality.

Returns

the pdf compression quality

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_SetBitonalFormat()

void CPdfCompressionOptions_SetBitonalFormat	(	CPdfCompressionOptions	argCPdfCompressionOptions,
		enum ImageFormat const	evBitonalFormat,
		idrs_exception *	pargException
	)

Sets the Bitonal file format. This compression format will be used when input is black and white, or for the mask layer if PDF PageDisplay is set to HyperCompressed.

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle
evBitonalFormat	Bitonal file format
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_SetColorFormat()

void CPdfCompressionOptions_SetColorFormat	(	CPdfCompressionOptions	argCPdfCompressionOptions,
		enum ImageFormat const	evColorFormat,
		idrs_exception *	pargException
	)

Sets the Color file format. This compression format will be used when when input is color or grayscale.

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle
evColorFormat	Color file format
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfCompressionOptions_SetCompressionQuality()

void CPdfCompressionOptions_SetCompressionQuality	(	CPdfCompressionOptions	argCPdfCompressionOptions,
		enum CompressionQuality const	evCompressionQuality,
		idrs_exception *	pargException
	)

Sets the pdf compression quality.

Parameters

argCPdfCompressionOptions	CPdfCompressionOptions handle
evCompressionQuality	pdf compression quality value
pargException	Pointer to exception structure that will be filled if an exception occurs