CEncryptionOptions_interface.h File Reference

Interface for CEncryptionOptions wrapper. More...

Go to the source code of this file.

Functions
CEncryptionOptions	CEncryptionOptions_Create (enum EncryptionAlgorithm const evEncryptionAlgorithm, idrs_exception *pargException)
	Create creates a CEncryptionOptions object.
enum EncryptionAlgorithm	CEncryptionOptions_GetEncryptionLevel (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the encryption level.
void	CEncryptionOptions_SetUserPassword (CEncryptionOptions argCEncryptionOptions, const idrs_string strUserPassword, idrs_exception *pargException)
	Sets the password required to open the document. Please note that if the password length is more than 32 characters, only the first 32 characters will be considered. Only ASCII characters are allowed in the password.
const idrs_string	CEncryptionOptions_GetUserPassword (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the password required to open the document.
void	CEncryptionOptions_SetOwnerPassword (CEncryptionOptions argCEncryptionOptions, const idrs_string strOwnerPassword, idrs_exception *pargException)
	Sets the owner password for the pdf document, allowing full access to it without taking restrictions into consideration. Please note that if the password length is more than 32 characters, only the first 32 characters will be considered. Only ASCII characters are allowed in the password. The accepted charsets are ANSI (range 0-127) and extended ANSI (range 128-255)
const idrs_string	CEncryptionOptions_GetOwnerPassword (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the owner password required to change permissions of the document.
void	CEncryptionOptions_SetPrintPermission (CEncryptionOptions argCEncryptionOptions, enum PrintPermission const evPrintPermission, idrs_exception *pargException)
	Sets the print permission for the pdf document.
enum PrintPermission	CEncryptionOptions_GetPrintPermission (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the print permission.
void	CEncryptionOptions_SetEditPermission (CEncryptionOptions argCEncryptionOptions, enum EditPermission const evEditPermission, idrs_exception *pargException)
	Sets the edit permission for the pdf document.
enum EditPermission	CEncryptionOptions_GetEditPermission (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the edit permission.
void	CEncryptionOptions_SetEnableContentCopy (CEncryptionOptions argCEncryptionOptions, IDRS_BOOL const bEnableContentCopy, idrs_exception *pargException)
	Sets a flag that allows or denies content copy.
IDRS_BOOL	CEncryptionOptions_GetEnableContentCopy (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the content copy flag.
void	CEncryptionOptions_SetEnableTextAccess (CEncryptionOptions argCEncryptionOptions, IDRS_BOOL const bEnableTextAccess, idrs_exception *pargException)
	Sets the text access enable flag.
IDRS_BOOL	CEncryptionOptions_GetEnableTextAccess (const CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Gets the flag specifying whether text access is enabled or not.
void	CEncryptionOptions_Destroy (CEncryptionOptions argCEncryptionOptions, idrs_exception *pargException)
	Destroys a CEncryptionOptions handle.

Detailed Description

Interface for CEncryptionOptions wrapper.

Function Documentation

CEncryptionOptions_Create()

CEncryptionOptions CEncryptionOptions_Create	(	enum EncryptionAlgorithm const	evEncryptionAlgorithm,
		idrs_exception *	pargException
	)

Create creates a CEncryptionOptions object.

Parameters

evEncryptionAlgorithm	The encryption level.
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_Destroy()

void CEncryptionOptions_Destroy	(	CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Destroys a CEncryptionOptions handle.

Parameters

argCEncryptionOptions	CEncryptionOptions handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetEditPermission()

enum EditPermission CEncryptionOptions_GetEditPermission	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the edit permission.

Returns

The edit permission.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetEnableContentCopy()

IDRS_BOOL CEncryptionOptions_GetEnableContentCopy	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the content copy flag.

Returns

Content copy flag

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetEnableTextAccess()

IDRS_BOOL CEncryptionOptions_GetEnableTextAccess	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the flag specifying whether text access is enabled or not.

Returns

flag for text access

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetEncryptionLevel()

enum EncryptionAlgorithm CEncryptionOptions_GetEncryptionLevel	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the encryption level.

Returns

the encryption level

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetOwnerPassword()

const idrs_string CEncryptionOptions_GetOwnerPassword	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the owner password required to change permissions of the document.

Returns

The owner password.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetPrintPermission()

enum PrintPermission CEncryptionOptions_GetPrintPermission	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the print permission.

Returns

The print permission.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_GetUserPassword()

const idrs_string CEncryptionOptions_GetUserPassword	(	const CEncryptionOptions	argCEncryptionOptions,
		idrs_exception *	pargException
	)

Gets the password required to open the document.

Returns

The user password.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_SetEditPermission()

void CEncryptionOptions_SetEditPermission	(	CEncryptionOptions	argCEncryptionOptions,
		enum EditPermission const	evEditPermission,
		idrs_exception *	pargException
	)

Sets the edit permission for the pdf document.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
evEditPermission	The edit permission to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_SetEnableContentCopy()

void CEncryptionOptions_SetEnableContentCopy	(	CEncryptionOptions	argCEncryptionOptions,
		IDRS_BOOL const	bEnableContentCopy,
		idrs_exception *	pargException
	)

Sets a flag that allows or denies content copy.

Please note it is not allowed to have content copy enabled while text access is disabled.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
bEnableContentCopy	flag specifying if copy operation is allowed or not
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_SetEnableTextAccess()

void CEncryptionOptions_SetEnableTextAccess	(	CEncryptionOptions	argCEncryptionOptions,
		IDRS_BOOL const	bEnableTextAccess,
		idrs_exception *	pargException
	)

Sets the text access enable flag.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
bEnableTextAccess	flag specifying whether to allow text access or not
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_SetOwnerPassword()

void CEncryptionOptions_SetOwnerPassword	(	CEncryptionOptions	argCEncryptionOptions,
		const idrs_string	strOwnerPassword,
		idrs_exception *	pargException
	)

Sets the owner password for the pdf document, allowing full access to it without taking restrictions into consideration. Please note that if the password length is more than 32 characters, only the first 32 characters will be considered. Only ASCII characters are allowed in the password. The accepted charsets are ANSI (range 0-127) and extended ANSI (range 128-255)

Remarks

The user password and owner password must be different.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
strOwnerPassword	Password that will protect the document permissions to be changed
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_SetPrintPermission()

void CEncryptionOptions_SetPrintPermission	(	CEncryptionOptions	argCEncryptionOptions,
		enum PrintPermission const	evPrintPermission,
		idrs_exception *	pargException
	)

Sets the print permission for the pdf document.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
evPrintPermission	The print permission to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CEncryptionOptions_SetUserPassword()

void CEncryptionOptions_SetUserPassword	(	CEncryptionOptions	argCEncryptionOptions,
		const idrs_string	strUserPassword,
		idrs_exception *	pargException
	)

Sets the password required to open the document. Please note that if the password length is more than 32 characters, only the first 32 characters will be considered. Only ASCII characters are allowed in the password.

Remarks

The user password and owner password (if set) must be different.

Parameters

argCEncryptionOptions	CEncryptionOptions handle
strUserPassword	The user password.
pargException	Pointer to exception structure that will be filled if an exception occurs