Error types

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_LICENSE_REQUIRED
	Error accessing licensed feature without a valid license file.
const error_type	VANILLAPDF_ERROR_INSUFFICIENT_SPACE
	The space usually for buffer was not sufficient for requested operation.
const error_type	VANILLAPDF_ERROR_GENERAL
	An unknown error has occurred.
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.
const error_type	VANILLAPDF_ERROR_OBJECT_MISSING
	A dependent object was not found.
const error_type	VANILLAPDF_ERROR_PARSE_EXCEPTION
	Error during low-level file processing, the document might be damaged.
const error_type	VANILLAPDF_ERROR_INVALID_PASSWORD
	Invalid protection password or key.
const error_type	VANILLAPDF_ERROR_DUPLICATE_KEY
	Raise when trying to insert already existing key into the dictionary.
const error_type	VANILLAPDF_ERROR_OPTIONAL_ENTRY_MISSING
	The requested object is empty or missing.
const error_type	VANILLAPDF_ERROR_SEMANTIC_CONTEXT
	The underlying type of the object was different than expected.

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

VANILLAPDF_ERROR_GENERAL

const error_type VANILLAPDF_ERROR_GENERAL

extern

An unknown error has occurred.

Try to turn on Logging for extended informations.

VANILLAPDF_ERROR_FILE_NOT_INITIALIZED

const error_type VANILLAPDF_ERROR_FILE_NOT_INITIALIZED

extern

The source file was not yet initialized.

See also

File_Initialize

VANILLAPDF_ERROR_OBJECT_MISSING

const error_type VANILLAPDF_ERROR_OBJECT_MISSING

extern

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.

VANILLAPDF_ERROR_PARSE_EXCEPTION

const error_type VANILLAPDF_ERROR_PARSE_EXCEPTION

extern

Error during low-level file processing, the document might be damaged.

If the document can be correctly processed with other readers, please let us know by sending the document for observations. In case the document contains sensitive information, consider document anonymizer utility.

VANILLAPDF_ERROR_INVALID_PASSWORD

const error_type VANILLAPDF_ERROR_INVALID_PASSWORD

extern

Invalid protection password or key.

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