Interface for CPdfOutputParams wrapper. More...

Functions
CPdfOutputParams	CPdfOutputParams_Create (enum PdfVersion const evPdfVersion, enum PageDisplay const evPageDisplay, idrs_exception *pargException)
	Create is instantiating a new instance of CPdfOutputParams and associated data object.

enum PdfVersion	CPdfOutputParams_GetPdfVersion (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the pdf version.

enum PageDisplay	CPdfOutputParams_GetPageDisplay (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the page display type.

CPdfCustomMetadata	CPdfOutputParams_GetPdfCustomMetadata (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the pdf custom metadata.

void	CPdfOutputParams_SetPdfCustomMetadata (CPdfOutputParams argCPdfOutputParams, const CPdfCustomMetadata argPdfCustomMetadata, idrs_exception *pargException)
	Sets the pdf custom metadata.

CEncryptionOptions	CPdfOutputParams_GetEncryptionOptions (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the encryption options.

void	CPdfOutputParams_SetEncryptionOptions (CPdfOutputParams argCPdfOutputParams, const CEncryptionOptions argEncryptionOptions, idrs_exception *pargException)
	Sets the encryption options.

CBookmarksOptions	CPdfOutputParams_GetBookmarksOptions (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Get the pdf bookmarks options.

void	CPdfOutputParams_SetBookmarksOptions (CPdfOutputParams argCPdfOutputParams, const CBookmarksOptions argBookmarksOptions, idrs_exception *pargException)
	Set the pdf bookmarks options.

CPdfCompressionOptions	CPdfOutputParams_GetPdfCompressionOptions (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the pdf compression options object.

void	CPdfOutputParams_SetPdfCompressionOptions (CPdfOutputParams argCPdfOutputParams, const CPdfCompressionOptions argPdfCompressionOptions, idrs_exception *pargException)
	Sets the pdf compression options object.

CDocumentSeparationOptions	CPdfOutputParams_GetDocumentSeparationOptions (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the Pdf document separation options object.

void	CPdfOutputParams_SetDocumentSeparationOptions (CPdfOutputParams argCPdfOutputParams, const CDocumentSeparationOptions argDocumentSeparationOptions, idrs_exception *pargException)
	Sets the Pdf document separation options object.

IDRS_BOOL	CPdfOutputParams_GetUseOriginalRotation (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets a boolean flag indicating whether the use original rotation is enabled.

void	CPdfOutputParams_SetUseOriginalRotation (CPdfOutputParams argCPdfOutputParams, IDRS_BOOL const bUseOriginalRotation, idrs_exception *pargException)
	Sets a boolean flag indicating whether the use original rotation is enabled.

IDRS_BOOL	CPdfOutputParams_GetEmbedFonts (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the boolean flag specifying if the embed fonts is enabled.

void	CPdfOutputParams_SetEmbedFonts (CPdfOutputParams argCPdfOutputParams, IDRS_BOOL const bEmbedFonts, idrs_exception *pargException)
	Gets the boolean flag specifying if the embed fonts is enabled.

void	CPdfOutputParams_SetAccessibilityConformance (CPdfOutputParams argCPdfOutputParams, IDRS_BOOL const bAccessibilityConformance, idrs_exception *pargException)
	Sets the flag that enables accessibility conformance for the pdf document.

IDRS_BOOL	CPdfOutputParams_GetAccessibilityConformance (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the flag that enables accessibility conformance for the pdf document.

void	CPdfOutputParams_SetLinearized (CPdfOutputParams argCPdfOutputParams, IDRS_BOOL const bLinearized, idrs_exception *pargException)
	Sets the flag that enables linearization of the pdf document.

IDRS_BOOL	CPdfOutputParams_GetLinearized (const CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Gets the flag that enables linearization of the pdf document.

void	CPdfOutputParams_Destroy (CPdfOutputParams argCPdfOutputParams, idrs_exception *pargException)
	Destroys a CPdfOutputParams handle.

Detailed Description

Interface for CPdfOutputParams wrapper.

Function Documentation

◆ CPdfOutputParams_Create()

CPdfOutputParams CPdfOutputParams_Create	(	enum PdfVersion const	evPdfVersion,
		enum PageDisplay const	evPageDisplay,
		idrs_exception *	pargException
	)

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

Parameters

evPdfVersion	pdf version value
evPageDisplay	page display value
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns: New instance of CPdfOutputParams

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

◆ CPdfOutputParams_Destroy()

void CPdfOutputParams_Destroy	(	CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Destroys a CPdfOutputParams handle.

Parameters

argCPdfOutputParams	CPdfOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetAccessibilityConformance()

IDRS_BOOL CPdfOutputParams_GetAccessibilityConformance	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the flag that enables accessibility conformance for the pdf document.

Returns: Pdf accessibility conformance flag.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetBookmarksOptions()

CBookmarksOptions CPdfOutputParams_GetBookmarksOptions	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Get the pdf bookmarks options.

Returns: the bookmarks options

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetDocumentSeparationOptions()

CDocumentSeparationOptions CPdfOutputParams_GetDocumentSeparationOptions	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the Pdf document separation options object.

Returns: The Pdf document separation options object.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetEmbedFonts()

IDRS_BOOL CPdfOutputParams_GetEmbedFonts	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the boolean flag specifying if the embed fonts is enabled.

Returns: IDRS_TRUE if embed fonts is enabled, otherwise IDRS_FALSE

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetEncryptionOptions()

CEncryptionOptions CPdfOutputParams_GetEncryptionOptions	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the encryption options.

Returns: the encryption options object

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetLinearized()

IDRS_BOOL CPdfOutputParams_GetLinearized	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the flag that enables linearization of the pdf document.

Returns: Linearization flag.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetPageDisplay()

enum PageDisplay CPdfOutputParams_GetPageDisplay	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the page display type.

Returns: the page display type

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetPdfCompressionOptions()

CPdfCompressionOptions CPdfOutputParams_GetPdfCompressionOptions	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the pdf compression options object.

Returns: the Pdf compression options object

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetPdfCustomMetadata()

CPdfCustomMetadata CPdfOutputParams_GetPdfCustomMetadata	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the pdf custom metadata.

Returns: the pdf custom metadata object

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetPdfVersion()

enum PdfVersion CPdfOutputParams_GetPdfVersion	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets the pdf version.

Returns: the pdf version

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_GetUseOriginalRotation()

IDRS_BOOL CPdfOutputParams_GetUseOriginalRotation	(	const CPdfOutputParams	argCPdfOutputParams,
		idrs_exception *	pargException
	)

Gets a boolean flag indicating whether the use original rotation is enabled.

Returns: IDRS_TRUE if use original rotation is enabled, otherwise IDRS_FALSE

Parameters

argCPdfOutputParams	CPdfOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetAccessibilityConformance()

void CPdfOutputParams_SetAccessibilityConformance	(	CPdfOutputParams	argCPdfOutputParams,
		IDRS_BOOL const	bAccessibilityConformance,
		idrs_exception *	pargException
	)

Sets the flag that enables accessibility conformance for the pdf document.

Enabling the pdf accessibility will have the effect that the output pdfs will be PDF/UA compliant.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
bAccessibilityConformance	Boolean flag used to enable/disable the pdf accessibility conformance
pargException	Pointer to exception structure that will be filled if an exception occurs

Note: Enabling pdf accessibility requires pdf version 1.7 and higher.; Accessibility conformance requires fonts to be embedded, and text access to be enabled in case of encryption. If the flag for accessibility is set to true, these two other properties will therefore be changed to the appropriate value.

◆ CPdfOutputParams_SetBookmarksOptions()

void CPdfOutputParams_SetBookmarksOptions	(	CPdfOutputParams	argCPdfOutputParams,
		const CBookmarksOptions	argBookmarksOptions,
		idrs_exception *	pargException
	)

Set the pdf bookmarks options.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
argBookmarksOptions	the bookmarks options
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetDocumentSeparationOptions()

void CPdfOutputParams_SetDocumentSeparationOptions	(	CPdfOutputParams	argCPdfOutputParams,
		const CDocumentSeparationOptions	argDocumentSeparationOptions,
		idrs_exception *	pargException
	)

Sets the Pdf document separation options object.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
argDocumentSeparationOptions	The Pdf document separation options object.
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetEmbedFonts()

void CPdfOutputParams_SetEmbedFonts	(	CPdfOutputParams	argCPdfOutputParams,
		IDRS_BOOL const	bEmbedFonts,
		idrs_exception *	pargException
	)

Gets the boolean flag specifying if the embed fonts is enabled.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
bEmbedFonts	bolean indicating the font embedding status
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetEncryptionOptions()

void CPdfOutputParams_SetEncryptionOptions	(	CPdfOutputParams	argCPdfOutputParams,
		const CEncryptionOptions	argEncryptionOptions,
		idrs_exception *	pargException
	)

Sets the encryption options.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
argEncryptionOptions	an encryption options object
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetLinearized()

void CPdfOutputParams_SetLinearized	(	CPdfOutputParams	argCPdfOutputParams,
		IDRS_BOOL const	bLinearized,
		idrs_exception *	pargException
	)

Sets the flag that enables linearization of the pdf document.

Linearization (aka Fast Web View) allows a PDF to be loaded incrementally. This is advantageous when a document is loaded over the web.

Linearization is enabled by default

Parameters

argCPdfOutputParams	CPdfOutputParams handle
bLinearized	Boolean flag used to enable/disable the pdf linearization.
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetPdfCompressionOptions()

void CPdfOutputParams_SetPdfCompressionOptions	(	CPdfOutputParams	argCPdfOutputParams,
		const CPdfCompressionOptions	argPdfCompressionOptions,
		idrs_exception *	pargException
	)

Sets the pdf compression options object.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
argPdfCompressionOptions	a Pdf compression options object
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetPdfCustomMetadata()

void CPdfOutputParams_SetPdfCustomMetadata	(	CPdfOutputParams	argCPdfOutputParams,
		const CPdfCustomMetadata	argPdfCustomMetadata,
		idrs_exception *	pargException
	)

Sets the pdf custom metadata.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
argPdfCustomMetadata	a pdf custom metadata object
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPdfOutputParams_SetUseOriginalRotation()

void CPdfOutputParams_SetUseOriginalRotation	(	CPdfOutputParams	argCPdfOutputParams,
		IDRS_BOOL const	bUseOriginalRotation,
		idrs_exception *	pargException
	)

Sets a boolean flag indicating whether the use original rotation is enabled.

Parameters

argCPdfOutputParams	CPdfOutputParams handle
bUseOriginalRotation	bolean indicating the status
pargException	Pointer to exception structure that will be filled if an exception occurs

Functions

Detailed Description

Function Documentation

◆ CPdfOutputParams_Create()

◆ CPdfOutputParams_Destroy()

◆ CPdfOutputParams_GetAccessibilityConformance()

◆ CPdfOutputParams_GetBookmarksOptions()

◆ CPdfOutputParams_GetDocumentSeparationOptions()

◆ CPdfOutputParams_GetEmbedFonts()

◆ CPdfOutputParams_GetEncryptionOptions()

◆ CPdfOutputParams_GetLinearized()

◆ CPdfOutputParams_GetPageDisplay()

◆ CPdfOutputParams_GetPdfCompressionOptions()

◆ CPdfOutputParams_GetPdfCustomMetadata()

◆ CPdfOutputParams_GetPdfVersion()

◆ CPdfOutputParams_GetUseOriginalRotation()

◆ CPdfOutputParams_SetAccessibilityConformance()

◆ CPdfOutputParams_SetBookmarksOptions()

◆ CPdfOutputParams_SetDocumentSeparationOptions()

◆ CPdfOutputParams_SetEmbedFonts()

◆ CPdfOutputParams_SetEncryptionOptions()

◆ CPdfOutputParams_SetLinearized()

◆ CPdfOutputParams_SetPdfCompressionOptions()

◆ CPdfOutputParams_SetPdfCustomMetadata()

◆ CPdfOutputParams_SetUseOriginalRotation()