CPdfOperation_interface.h File Reference

Interface for CPdfOperation wrapper. More...

Go to the source code of this file.

Functions
IDRS_ERROR	CPdfOperation_ApplySignature (const idrs_string strInputFilePath, const idrs_string strOutputFilePath, const idrs_string strPassword, const CDigitalSignature argDigitalSignature, const CPdfUpdateParams argPdfUpdateParams, idrs_exception *pargException)
	Adds a digital signature to an existing PDF document and save the result to another document.
IDRS_ERROR	CPdfOperation_ApplySignature2 (const idrs_string strDocumentFilePath, const idrs_string strPassword, const CDigitalSignature argDigitalSignature, const CPdfUpdateParams argPdfUpdateParams, idrs_exception *pargException)
	Adds a digital signature to an existing PDF document and save the result in the same document (appending)
IDRS_ERROR	CPdfOperation_ApplySignature3 (IByteStream argInputStream, IByteStream argOutputStream, const idrs_string strPassword, const CDigitalSignature argDigitalSignature, const CPdfUpdateParams argPdfUpdateParams, idrs_exception *pargException)
	Adds a digital signature to an existing PDF document and save the result to another document.
IDRS_ERROR	CPdfOperation_ApplySignature4 (IByteStream argDocumentStream, const idrs_string strPassword, const CDigitalSignature argDigitalSignature, const CPdfUpdateParams argPdfUpdateParams, idrs_exception *pargException)
	Adds a digital signature to an existing PDF document and save the result in the same document (appending)
IDRS_ERROR	CPdfOperation_CompressedAsPdf (const idrs_string strInputFilePath, IByteStream argOutputStream, const CPdfOutputParams argPdfOutputParams, idrs_exception *pargException)
	Loads the input image or PDF document and creates a compressed PDF document.
IDRS_ERROR	CPdfOperation_CompressedAsPdf2 (const idrs_string strInputFilePath, IByteStream argOutputStream, idrs_exception *pargException)
	Loads the input image or PDF document and creates a compressed PDF document.
IDRS_ERROR	CPdfOperation_CompressedAsPdf3 (const idrs_string strInputFilePath, const idrs_string strOutputFilePath, const CPdfOutputParams argPdfOutputParams, idrs_exception *pargException)
	Loads the input image or PDF document and creates a compressed PDF document.
IDRS_ERROR	CPdfOperation_CompressedAsPdf4 (const idrs_string strInputFilePath, const idrs_string strOutputFilePath, idrs_exception *pargException)
	Loads the input image or PDF document and creates a compressed PDF document.

Detailed Description

Interface for CPdfOperation wrapper.

Function Documentation

CPdfOperation_ApplySignature()

IDRS_ERROR CPdfOperation_ApplySignature	(	const idrs_string	strInputFilePath,
		const idrs_string	strOutputFilePath,
		const idrs_string	strPassword,
		const CDigitalSignature	argDigitalSignature,
		const CPdfUpdateParams	argPdfUpdateParams,
		idrs_exception *	pargException
	)

Adds a digital signature to an existing PDF document and save the result to another document.

Parameters

strInputFilePath	Path to the PDF document
strOutputFilePath	Path to the new PDF document to create
strPassword	Owner password if specified otherwise User password used to open the PDF document. (empty if it is not password-protected)
argDigitalSignature	digital signature to apply
argPdfUpdateParams	The PDF update parameters
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the digital signature was properly added, a specific error code otherwise

Requirements:

IDRS::Module::DocumentOutput

IDRS::Module::ImageFormats with Extension::ImageFormatsPdfInput

Remarks

If the input PDF is a PDF/A, the method will throw an exception with code IDRS_ERROR_INVALID_ARGS unless font embedding is set in the PDF Update params.

CPdfOperation_ApplySignature2()

IDRS_ERROR CPdfOperation_ApplySignature2	(	const idrs_string	strDocumentFilePath,
		const idrs_string	strPassword,
		const CDigitalSignature	argDigitalSignature,
		const CPdfUpdateParams	argPdfUpdateParams,
		idrs_exception *	pargException
	)

Adds a digital signature to an existing PDF document and save the result in the same document (appending)

Parameters

strDocumentFilePath	Path to the PDF document to update
strPassword	Owner password if specified otherwise User password used to open the PDF document. (empty if it is not password-protected)
argDigitalSignature	digital signature to apply
argPdfUpdateParams	The PDF update parameters
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the digital signature was properly added, a specific error code otherwise

Remarks

Updating the input file "in-place" will be faster and consume less memory, however if the method fails, the document may be corrupted.

Requirements:

IDRS::Module::DocumentOutput

IDRS::Module::ImageFormats with Extension::ImageFormatsPdfInput

Remarks

If the input PDF is a PDF/A, the method will throw an exception with code IDRS_ERROR_INVALID_ARGS unless font embedding is set in the PDF Update params.

CPdfOperation_ApplySignature3()

IDRS_ERROR CPdfOperation_ApplySignature3	(	IByteStream	argInputStream,
		IByteStream	argOutputStream,
		const idrs_string	strPassword,
		const CDigitalSignature	argDigitalSignature,
		const CPdfUpdateParams	argPdfUpdateParams,
		idrs_exception *	pargException
	)

Adds a digital signature to an existing PDF document and save the result to another document.

Parameters

argInputStream	Stream opened on the PDF document
argOutputStream	Stream to the new PDF document to create
strPassword	Owner password if specified otherwise User password used to open the PDF document. (empty if it is not password-protected)
argDigitalSignature	digital signature to apply
argPdfUpdateParams	The PDF update parameters
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the digital signature was properly added, a specific error code otherwise

Requirements:

IDRS::Module::DocumentOutput

IDRS::Module::ImageFormats with Extension::ImageFormatsPdfInput

Remarks

If the input PDF is a PDF/A, the method will throw an exception with code IDRS_ERROR_INVALID_ARGS unless font embedding is set in the PDF Update params.

CPdfOperation_ApplySignature4()

IDRS_ERROR CPdfOperation_ApplySignature4	(	IByteStream	argDocumentStream,
		const idrs_string	strPassword,
		const CDigitalSignature	argDigitalSignature,
		const CPdfUpdateParams	argPdfUpdateParams,
		idrs_exception *	pargException
	)

Adds a digital signature to an existing PDF document and save the result in the same document (appending)

Parameters

argDocumentStream	Stream opened on the PDF document to update
strPassword	Owner password if specified otherwise User password used to open the PDF document. (empty if it is not password-protected)
argDigitalSignature	digital signature to apply
argPdfUpdateParams	The PDF update parameters
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the digital signature was properly added, a specific error code otherwise

Remarks

Updating the input file "in-place" will be faster and consume less memory, however if the method fails, the document may be corrupted.

Requirements:

IDRS::Module::DocumentOutput

IDRS::Module::ImageFormats with Extension::ImageFormatsPdfInput

Remarks

If the input PDF is a PDF/A, the method will throw an exception with code IDRS_ERROR_INVALID_ARGS unless font embedding is set in the PDF Update params.

CPdfOperation_CompressedAsPdf()

IDRS_ERROR CPdfOperation_CompressedAsPdf	(	const idrs_string	strInputFilePath,
		IByteStream	argOutputStream,
		const CPdfOutputParams	argPdfOutputParams,
		idrs_exception *	pargException
	)

Loads the input image or PDF document and creates a compressed PDF document.

Parameters

strInputFilePath	Paths to the input image or PDF document.
argOutputStream	Stream to the new PDF document to create
argPdfOutputParams	The PDF output parameters to be used to create the output PDF document (optional)
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the PDF document was successfully created, a specific error code otherwise.

Remarks

No OCR processing is performed on the input document, however the text layer of PDF inputs is preserved. By default, if no output parameter is provided, a PDF 1.5 iHQC with FavorSizeOverQuality compression quality is created.

CPdfOperation_CompressedAsPdf2()

IDRS_ERROR CPdfOperation_CompressedAsPdf2	(	const idrs_string	strInputFilePath,
		IByteStream	argOutputStream,
		idrs_exception *	pargException
	)

Loads the input image or PDF document and creates a compressed PDF document.

Parameters

strInputFilePath	Paths to the input image or PDF document.
argOutputStream	Stream to the new PDF document to create
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the PDF document was successfully created, a specific error code otherwise.

Remarks

No OCR processing is performed on the input document, however the text layer of PDF inputs is preserved. By default, if no output parameter is provided, a PDF 1.5 iHQC with FavorSizeOverQuality compression quality is created.

CPdfOperation_CompressedAsPdf3()

IDRS_ERROR CPdfOperation_CompressedAsPdf3	(	const idrs_string	strInputFilePath,
		const idrs_string	strOutputFilePath,
		const CPdfOutputParams	argPdfOutputParams,
		idrs_exception *	pargException
	)

Loads the input image or PDF document and creates a compressed PDF document.

Parameters

strInputFilePath	Paths to the input image or PDF document.
strOutputFilePath	Path to the new PDF document to create
argPdfOutputParams	The PDF output parameters to be used to create the output PDF document (optional)
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the PDF document was successfully created, a specific error code otherwise.

Remarks

No OCR processing is performed on the input document, however the text layer of PDF inputs is preserved. By default, if no output parameter is provided, a PDF 1.5 iHQC with FavorSizeOverQuality compression quality is created.

CPdfOperation_CompressedAsPdf4()

IDRS_ERROR CPdfOperation_CompressedAsPdf4	(	const idrs_string	strInputFilePath,
		const idrs_string	strOutputFilePath,
		idrs_exception *	pargException
	)

Loads the input image or PDF document and creates a compressed PDF document.

Parameters

strInputFilePath	Paths to the input image or PDF document.
strOutputFilePath	Path to the new PDF document to create
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_SUCCESS if the PDF document was successfully created, a specific error code otherwise.

Remarks

No OCR processing is performed on the input document, however the text layer of PDF inputs is preserved. By default, if no output parameter is provided, a PDF 1.5 iHQC with FavorSizeOverQuality compression quality is created.