Defines a type and ranges of possible return values from whole API. More...

Variables
const error_type	VANILLAPDF_ERROR_SUCCESS
	Indicates that the operation completed successfully.

const error_type	VANILLAPDF_ERROR_PARAMETER_VALUE
	An invalid parameter value to function call was passed.

const error_type	VANILLAPDF_ERROR_NOT_SUPPORTED
	Operation is currently not supported.

const error_type	VANILLAPDF_ERROR_USER_CANCELLED
	Operation was cancelled by user.

const error_type	VANILLAPDF_ERROR_ZLIB_DATA
	Error in compressed data.

const error_type	VANILLAPDF_ERROR_INVALID_LICENSE
	Presented license file is not valid.

const error_type	VANILLAPDF_ERROR_GENERAL
	An unknown error has occurred. More...

const error_type	VANILLAPDF_ERROR_CONVERSION
	An invalid object type was passed to function.

const error_type	VANILLAPDF_ERROR_FILE_DISPOSED
	The source file was already disposed.

const error_type	VANILLAPDF_ERROR_FILE_NOT_INITIALIZED
	The source file was not yet initialized. More...

const error_type	VANILLAPDF_ERROR_OBJECT_MISSING
	A dependent object was not found. More...

const error_type	VANILLAPDF_ERROR_INVALID_PASSWORD
	Invalid protection password or key. More...

Detailed Description

Defines a type and ranges of possible return values from whole API.

Please refer to these variables when checking for function return values instead of any other constants (such as 0).

Whole possible range of return values is described in this module.

Variable Documentation

const error_type VANILLAPDF_ERROR_GENERAL

An unknown error has occurred.

Try to turn on Logging for extended informations.

const error_type VANILLAPDF_ERROR_FILE_NOT_INITIALIZED

The source file was not yet initialized.

const error_type VANILLAPDF_ERROR_OBJECT_MISSING

A dependent object was not found.

In order to complete a task, library needed to find and object, which was unavailable. I believe, this should not happen.

const error_type VANILLAPDF_ERROR_INVALID_PASSWORD

Invalid protection password or key.

The source file was encrypted, while the entered password did not match.