CPdfUpdateParams_interface.h File Reference

Interface for CPdfUpdateParams wrapper. More...

Go to the source code of this file.

Functions
CPdfUpdateParams	CPdfUpdateParams_Create (idrs_exception *pargException)
	The Create method creates a CPdfUpdateParams object with default configuration (do not embed signature fonts, and use default pdf image compression parameters).
CPdfUpdateParams	CPdfUpdateParams_Create2 (IDRS_BOOL const bEmbedSignatureFonts, const CPdfCompressionOptions argPdfSignatureCompressionOptions, idrs_exception *pargException)
	The Create method creates a CPdfUpdateParams object.
IDRS_BOOL	CPdfUpdateParams_GetEmbedSignatureFonts (const CPdfUpdateParams argCPdfUpdateParams, idrs_exception *pargException)
	Get the font Embed Signature Fonts flag's value.
void	CPdfUpdateParams_SetEmbedSignatureFonts (CPdfUpdateParams argCPdfUpdateParams, IDRS_BOOL const bEmbedSignatureFonts, idrs_exception *pargException)
	Set the font embedding flag's value.
CPdfCompressionOptions	CPdfUpdateParams_GetSignatureCompressionOptions (const CPdfUpdateParams argCPdfUpdateParams, idrs_exception *pargException)
	Get the signature image compression attribute object.
void	CPdfUpdateParams_SetSignatureCompressionOptions (CPdfUpdateParams argCPdfUpdateParams, const CPdfCompressionOptions argPdfSignatureCompressionOptions, idrs_exception *pargException)
	Set the signature image compression parameters to use.
void	CPdfUpdateParams_Destroy (CPdfUpdateParams argCPdfUpdateParams, idrs_exception *pargException)
	Destroys a CPdfUpdateParams handle.

Detailed Description

Interface for CPdfUpdateParams wrapper.

Function Documentation

CPdfUpdateParams_Create()

CPdfUpdateParams CPdfUpdateParams_Create

(

idrs_exception *

pargException

)

The Create method creates a CPdfUpdateParams object with default configuration (do not embed signature fonts, and use default pdf image compression parameters).

Returns

The newly created CPdfUpdateParams object.

Parameters

pargException

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

CPdfUpdateParams_Create2()

CPdfUpdateParams CPdfUpdateParams_Create2	(	IDRS_BOOL const	bEmbedSignatureFonts,
		const CPdfCompressionOptions	argPdfSignatureCompressionOptions,
		idrs_exception *	pargException
	)

The Create method creates a CPdfUpdateParams object.

Parameters

bEmbedSignatureFonts	embed signature fonts flag value.
argPdfSignatureCompressionOptions	Signature compression options object.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CPdfUpdateParams object.

CPdfUpdateParams_Destroy()

void CPdfUpdateParams_Destroy	(	CPdfUpdateParams	argCPdfUpdateParams,
		idrs_exception *	pargException
	)

Destroys a CPdfUpdateParams handle.

Parameters

argCPdfUpdateParams	CPdfUpdateParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfUpdateParams_GetEmbedSignatureFonts()

IDRS_BOOL CPdfUpdateParams_GetEmbedSignatureFonts	(	const CPdfUpdateParams	argCPdfUpdateParams,
		idrs_exception *	pargException
	)

Get the font Embed Signature Fonts flag's value.

Return values

IDRS_TRUE	if the signature font embedding flag is set
IDRS_FALSE	otherwise

Parameters

argCPdfUpdateParams	CPdfUpdateParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfUpdateParams_GetSignatureCompressionOptions()

CPdfCompressionOptions CPdfUpdateParams_GetSignatureCompressionOptions	(	const CPdfUpdateParams	argCPdfUpdateParams,
		idrs_exception *	pargException
	)

Get the signature image compression attribute object.

Returns

the signature image compression parameters object.

Parameters

argCPdfUpdateParams	CPdfUpdateParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfUpdateParams_SetEmbedSignatureFonts()

void CPdfUpdateParams_SetEmbedSignatureFonts	(	CPdfUpdateParams	argCPdfUpdateParams,
		IDRS_BOOL const	bEmbedSignatureFonts,
		idrs_exception *	pargException
	)

Set the font embedding flag's value.

Parameters

argCPdfUpdateParams	CPdfUpdateParams handle
bEmbedSignatureFonts	value to set to the font embedding flag.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPdfUpdateParams_SetSignatureCompressionOptions()

void CPdfUpdateParams_SetSignatureCompressionOptions	(	CPdfUpdateParams	argCPdfUpdateParams,
		const CPdfCompressionOptions	argPdfSignatureCompressionOptions,
		idrs_exception *	pargException
	)

Set the signature image compression parameters to use.

Parameters

argCPdfUpdateParams	CPdfUpdateParams handle
argPdfSignatureCompressionOptions	The signature compression parameters to use.
pargException	Pointer to exception structure that will be filled if an exception occurs