Types

typedef uint32_t error_type

This is return value type of all API functions.

typedef int8_t boolean_type

Boolean type supported in C.

typedef double real_type

Floating point values.

typedef uint16_t ushort_type

16-bit unsigned integer

typedef int32_t integer_type

32-bit signed integer

typedef int64_t offset_type

Offset type compatible with standard IO.

typedef uint32_t size_type

Size type defined in standard library.

typedef int64_t bigint_type

64-bit signed integer type

typedef uint64_t biguint_type

64-bit unsigned integer type

typedef const char *string_type

C-Style string.

typedef char *byte_array_type

Writeable byte array.

Boolean Types

const boolean_type VANILLAPDF_RV_FALSE

Represents the boolean false value.

It shall respond to false value as defined in c++ standard. However, I recommend using this constant instead of not operator or any other constant, that may seem to work.

const boolean_type VANILLAPDF_RV_TRUE

Represents the boolean true value.

It shall respond to true value as defined in c++ standard.

Error Types

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.

Try to turn on Logging for extended informations.

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.

See also

File_Initialize

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_PARSE_EXCEPTION

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.

const error_type VANILLAPDF_ERROR_INVALID_PASSWORD

Invalid protection password or key.

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

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.