CPageMetadata_interface.h File Reference

Interface for CPageMetadata wrapper. More...

Go to the source code of this file.

Functions
CPageMetadata	CPageMetadata_Create (idrs_exception *pargException)
	Creates a new instance.
CPageInteractiveForm	CPageMetadata_GetInteractiveForm (const CPageMetadata argCPageMetadata, idrs_exception *pargException)
	Returns the page's interactive form.
void	CPageMetadata_SetInteractiveForm (CPageMetadata argCPageMetadata, const CPageInteractiveForm pobjInteractiveForm, idrs_exception *pargException)
	Sets the page's interactive form.
void	CPageMetadata_SetOriginalOrientation (CPageMetadata argCPageMetadata, enum PageOrientation const evPageRotation, idrs_exception *pargException)
	Sets the value for the original rotation of the input source.
enum PageOrientation	CPageMetadata_GetOriginalOrientation (const CPageMetadata argCPageMetadata, idrs_exception *pargException)
	Gets the original rotation of the input source.
void	CPageMetadata_SetBarcodes (CPageMetadata argCPageMetadata, const CBarcodeArray argxBarcodes, idrs_exception *pargException)
	Sets the barcode data.
CBarcodeArray	CPageMetadata_GetBarcodes (const CPageMetadata argCPageMetadata, idrs_exception *pargException)
	Retrieve the barcode data.
void	CPageMetadata_Destroy (CPageMetadata argCPageMetadata, idrs_exception *pargException)
	Destroys a CPageMetadata handle.

Detailed Description

Interface for CPageMetadata wrapper.

Function Documentation

CPageMetadata_Create()

CPageMetadata CPageMetadata_Create

(

idrs_exception *

pargException

)

Creates a new instance.

Parameters

pargException

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

Remarks

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

CPageMetadata_Destroy()

void CPageMetadata_Destroy	(	CPageMetadata	argCPageMetadata,
		idrs_exception *	pargException
	)

Destroys a CPageMetadata handle.

Parameters

argCPageMetadata	CPageMetadata handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageMetadata_GetBarcodes()

CBarcodeArray CPageMetadata_GetBarcodes	(	const CPageMetadata	argCPageMetadata,
		idrs_exception *	pargException
	)

Retrieve the barcode data.

Parameters

argCPageMetadata	CPageMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageMetadata_GetInteractiveForm()

CPageInteractiveForm CPageMetadata_GetInteractiveForm	(	const CPageMetadata	argCPageMetadata,
		idrs_exception *	pargException
	)

Returns the page's interactive form.

Parameters

argCPageMetadata	CPageMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageMetadata_GetOriginalOrientation()

enum PageOrientation CPageMetadata_GetOriginalOrientation	(	const CPageMetadata	argCPageMetadata,
		idrs_exception *	pargException
	)

Gets the original rotation of the input source.

When running the OCR and automatic orientation detection is enabled, iDRS automatically sets the detected rotation angle as OriginalRotation. Since the OCR can only be executed on input sources with 0 degrees rotation, the input source is also rotated internally. This function is retrieving the original rotation angle of the input source image

Returns

Original rotation angle of the input source image

Parameters

argCPageMetadata	CPageMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageMetadata_SetBarcodes()

void CPageMetadata_SetBarcodes	(	CPageMetadata	argCPageMetadata,
		const CBarcodeArray	argxBarcodes,
		idrs_exception *	pargException
	)

Sets the barcode data.

Parameters

argCPageMetadata	CPageMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageMetadata_SetInteractiveForm()

void CPageMetadata_SetInteractiveForm	(	CPageMetadata	argCPageMetadata,
		const CPageInteractiveForm	pobjInteractiveForm,
		idrs_exception *	pargException
	)

Sets the page's interactive form.

Parameters

argCPageMetadata	CPageMetadata handle
pobjInteractiveForm	An interactive form object
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageMetadata_SetOriginalOrientation()

void CPageMetadata_SetOriginalOrientation	(	CPageMetadata	argCPageMetadata,
		enum PageOrientation const	evPageRotation,
		idrs_exception *	pargException
	)

Sets the value for the original rotation of the input source.

When running the OCR and automatic orientation detection is enabled, iDRS automatically sets the detected rotation angle as OriginalRotation. Since the OCR can only be executed on input sources with 0 degrees rotation, the input source is also rotated internally.

Updating the OriginalRotation is having an effect on the following output document types:

• PDF: when UseOriginalRotation is set to IDRS_TRUE in CPdfOutputParams

Parameters

argCPageMetadata	CPageMetadata handle
evPageRotation	New value for page rotation
pargException	Pointer to exception structure that will be filled if an exception occurs