CDigitalSignature_interface.h File Reference

Interface for CDigitalSignature wrapper. More...

Go to the source code of this file.

Functions
CDigitalSignature	CDigitalSignature_Create (idrs_exception *pargException)
	Create creates a CDigitalSignature object.
void	CDigitalSignature_SetSignatureContent (CDigitalSignature argCDigitalSignature, const CSignatureContent argSignatureContent, idrs_exception *pargException)
	Sets the signature visual content.
CSignatureContent	CDigitalSignature_GetSignatureContent (const CDigitalSignature argCDigitalSignature, idrs_exception *pargException)
	Retrieves the signature visual content.
void	CDigitalSignature_SetDigitalCertificate (CDigitalSignature argCDigitalSignature, const CDigitalCertificate argDigitalCertificate, idrs_exception *pargException)
	Sets the digital signature.
CDigitalCertificate	CDigitalSignature_GetDigitalCertificate (const CDigitalSignature argCDigitalSignature, idrs_exception *pargException)
	Retrieves the digital signature.
void	CDigitalSignature_SetPageIndex (CDigitalSignature argCDigitalSignature, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
	Sets the page index.
IDRS_UINT	CDigitalSignature_GetPageIndex (const CDigitalSignature argCDigitalSignature, idrs_exception *pargException)
	Retrieves the page index default value 0.
void	CDigitalSignature_Destroy (CDigitalSignature argCDigitalSignature, idrs_exception *pargException)
	Destroys a CDigitalSignature handle.
CDigitalSignatureArray	ArrayInterface_Create_CDigitalSignatureArray (idrs_exception *pargException)
	Creates a new CDigitalSignatureArray object.

Detailed Description

Interface for CDigitalSignature wrapper.

Function Documentation

ArrayInterface_Create_CDigitalSignatureArray()

CDigitalSignatureArray ArrayInterface_Create_CDigitalSignatureArray

(

idrs_exception *

pargException

)

Creates a new CDigitalSignatureArray object.

Parameters

pargException

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

Returns

The newly created CDigitalSignatureArray

CDigitalSignature_Create()

CDigitalSignature CDigitalSignature_Create

(

idrs_exception *

pargException

)

Create creates a CDigitalSignature object.

Returns

The newly created page.

Parameters

pargException

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

CDigitalSignature_Destroy()

void CDigitalSignature_Destroy	(	CDigitalSignature	argCDigitalSignature,
		idrs_exception *	pargException
	)

Destroys a CDigitalSignature handle.

Parameters

argCDigitalSignature	CDigitalSignature handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CDigitalSignature_GetDigitalCertificate()

CDigitalCertificate CDigitalSignature_GetDigitalCertificate	(	const CDigitalSignature	argCDigitalSignature,
		idrs_exception *	pargException
	)

Retrieves the digital signature.

Parameters

argCDigitalSignature	CDigitalSignature handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDigitalSignature_GetPageIndex()

IDRS_UINT CDigitalSignature_GetPageIndex	(	const CDigitalSignature	argCDigitalSignature,
		idrs_exception *	pargException
	)

Retrieves the page index default value 0.

Parameters

argCDigitalSignature	CDigitalSignature handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDigitalSignature_GetSignatureContent()

CSignatureContent CDigitalSignature_GetSignatureContent	(	const CDigitalSignature	argCDigitalSignature,
		idrs_exception *	pargException
	)

Retrieves the signature visual content.

Parameters

argCDigitalSignature	CDigitalSignature handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDigitalSignature_SetDigitalCertificate()

void CDigitalSignature_SetDigitalCertificate	(	CDigitalSignature	argCDigitalSignature,
		const CDigitalCertificate	argDigitalCertificate,
		idrs_exception *	pargException
	)

Sets the digital signature.

Parameters

argCDigitalSignature	CDigitalSignature handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDigitalSignature_SetPageIndex()

void CDigitalSignature_SetPageIndex	(	CDigitalSignature	argCDigitalSignature,
		IDRS_UINT const	uiPageIndex,
		idrs_exception *	pargException
	)

Sets the page index.

Parameters

argCDigitalSignature	CDigitalSignature handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDigitalSignature_SetSignatureContent()

void CDigitalSignature_SetSignatureContent	(	CDigitalSignature	argCDigitalSignature,
		const CSignatureContent	argSignatureContent,
		idrs_exception *	pargException
	)

Sets the signature visual content.

By default the signatures placed by iDRS do not have any visual elements. Using CSignatureContent you can define the way the signature looks on the pdf page as well as its location

Parameters

argCDigitalSignature	CDigitalSignature handle
pargException	Pointer to exception structure that will be filled if an exception occurs