Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
c_values.h
Go to the documentation of this file.
1#ifndef _C_VALUES_H
2#define _C_VALUES_H
3
4#include "vanillapdf/c_export.h"
5#include "vanillapdf/c_types.h"
6
12#ifdef __cplusplus
13extern "C"
14{
15#endif
16
30 VANILLAPDF_API extern const boolean_type VANILLAPDF_RV_FALSE;
31
38 VANILLAPDF_API extern const boolean_type VANILLAPDF_RV_TRUE;
39
40 /* group_boolean_types */
41
47 // global error states
48
53 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_SUCCESS;
54
59 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_PARAMETER_VALUE;
60
65 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_NOT_SUPPORTED;
66
71 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_USER_CANCELLED;
72
77 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_ZLIB_DATA;
78
83 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_INVALID_LICENSE;
84
89 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_LICENSE_REQUIRED;
90
95 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_INSUFFICIENT_SPACE;
96
103 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_GENERAL;
104
105 // syntax errors
106
111 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_CONVERSION;
112
117 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_FILE_DISPOSED;
118
125 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_FILE_NOT_INITIALIZED;
126
134 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_OBJECT_MISSING;
135
145 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_PARSE_EXCEPTION;
146
153 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_INVALID_PASSWORD;
154
159 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_DUPLICATE_KEY;
160
161 // semantic errors
162
167 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_OPTIONAL_ENTRY_MISSING;
168
173 VANILLAPDF_API extern const error_type VANILLAPDF_ERROR_SEMANTIC_CONTEXT;
174
175 /* group_error_types */
176
177#ifdef __cplusplus
178};
179#endif
180
181#endif /* _C_VALUES_H */
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.
c_types.h
This file contains type definitions.
VANILLAPDF_RV_TRUE
const boolean_type VANILLAPDF_RV_TRUE
Represents the boolean true value.
VANILLAPDF_RV_FALSE
const boolean_type VANILLAPDF_RV_FALSE
Represents the boolean false value.
VANILLAPDF_ERROR_INSUFFICIENT_SPACE
const error_type VANILLAPDF_ERROR_INSUFFICIENT_SPACE
The space usually for buffer was not sufficient for requested operation.
VANILLAPDF_ERROR_OBJECT_MISSING
const error_type VANILLAPDF_ERROR_OBJECT_MISSING
A dependent object was not found.
VANILLAPDF_ERROR_DUPLICATE_KEY
const error_type VANILLAPDF_ERROR_DUPLICATE_KEY
Raise when trying to insert already existing key into the dictionary.
VANILLAPDF_ERROR_LICENSE_REQUIRED
const error_type VANILLAPDF_ERROR_LICENSE_REQUIRED
Error accessing licensed feature without a valid license file.
VANILLAPDF_ERROR_PARAMETER_VALUE
const error_type VANILLAPDF_ERROR_PARAMETER_VALUE
An invalid parameter value to function call was passed.
VANILLAPDF_ERROR_SUCCESS
const error_type VANILLAPDF_ERROR_SUCCESS
Indicates that the operation completed successfully.
VANILLAPDF_ERROR_GENERAL
const error_type VANILLAPDF_ERROR_GENERAL
An unknown error has occurred.
VANILLAPDF_ERROR_SEMANTIC_CONTEXT
const error_type VANILLAPDF_ERROR_SEMANTIC_CONTEXT
The underlying type of the object was different than expected.
VANILLAPDF_ERROR_OPTIONAL_ENTRY_MISSING
const error_type VANILLAPDF_ERROR_OPTIONAL_ENTRY_MISSING
The requested object is empty or missing.
VANILLAPDF_ERROR_PARSE_EXCEPTION
const error_type VANILLAPDF_ERROR_PARSE_EXCEPTION
Error during low-level file processing, the document might be damaged.
VANILLAPDF_ERROR_USER_CANCELLED
const error_type VANILLAPDF_ERROR_USER_CANCELLED
Operation was cancelled by user.
VANILLAPDF_ERROR_ZLIB_DATA
const error_type VANILLAPDF_ERROR_ZLIB_DATA
Error in compressed data.
VANILLAPDF_ERROR_CONVERSION
const error_type VANILLAPDF_ERROR_CONVERSION
An invalid object type was passed to function.
VANILLAPDF_ERROR_INVALID_PASSWORD
const error_type VANILLAPDF_ERROR_INVALID_PASSWORD
Invalid protection password or key.
VANILLAPDF_ERROR_FILE_DISPOSED
const error_type VANILLAPDF_ERROR_FILE_DISPOSED
The source file was already disposed.
VANILLAPDF_ERROR_NOT_SUPPORTED
const error_type VANILLAPDF_ERROR_NOT_SUPPORTED
Operation is currently not supported.
VANILLAPDF_ERROR_INVALID_LICENSE
const error_type VANILLAPDF_ERROR_INVALID_LICENSE
Presented license file is not valid.
VANILLAPDF_ERROR_FILE_NOT_INITIALIZED
const error_type VANILLAPDF_ERROR_FILE_NOT_INITIALIZED
The source file was not yet initialized.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
boolean_type
int8_t boolean_type
Boolean type supported in C.
Definition c_types.h:31