Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_dictionary_object.h
Go to the documentation of this file.
1 #ifndef _C_DICTIONARY_OBJECT_H
2 #define _C_DICTIONARY_OBJECT_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
44  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_GetKey(DictionaryObjectIteratorHandle* handle, NameObjectHandle** result);
45 
52  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_GetValue(DictionaryObjectIteratorHandle* handle, ObjectHandle** result);
53 
61  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_IsValid(DictionaryObjectIteratorHandle* handle, DictionaryObjectHandle* parent, boolean_type* result);
62 
69  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_Next(DictionaryObjectIteratorHandle* handle);
70 
75  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_Release(DictionaryObjectIteratorHandle* handle);
76 
87  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Create(DictionaryObjectHandle** result);
88 
92  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Find(DictionaryObjectHandle* handle, const NameObjectHandle* key, ObjectHandle** result);
93 
97  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Contains(DictionaryObjectHandle* handle, const NameObjectHandle* key, boolean_type* result);
98 
104  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Iterator(DictionaryObjectHandle* handle, DictionaryObjectIteratorHandle** result);
105 
109  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Remove(DictionaryObjectHandle* handle, const NameObjectHandle* key);
110 
114  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Insert(DictionaryObjectHandle* handle, NameObjectHandle* key, ObjectHandle* value);
115 
119  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_InsertConst(DictionaryObjectHandle* handle, const NameObjectHandle* key, ObjectHandle* value);
120 
124  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Release(DictionaryObjectHandle* handle);
125 
128 #ifdef __cplusplus
129 };
130 #endif
131 
132 #endif /* _C_DICTIONARY_OBJECT_H */
error_type DictionaryObjectIterator_Next(DictionaryObjectIteratorHandle *handle)
Advances iterator to the next position.
error_type DictionaryObjectIterator_GetKey(DictionaryObjectIteratorHandle *handle, NameObjectHandle **result)
Get key at iterator position.
This file contains all type forward declarations returned by the library API.
error_type DictionaryObjectIterator_IsValid(DictionaryObjectIteratorHandle *handle, DictionaryObjectHandle *parent, boolean_type *result)
Determine if current position is valid.
error_type DictionaryObject_Insert(DictionaryObjectHandle *handle, NameObjectHandle *key, ObjectHandle *value)
Insert new key-value pair into collection.
Represents key-value map.
error_type DictionaryObjectIterator_GetValue(DictionaryObjectIteratorHandle *handle, ObjectHandle **result)
Get value at iterator position.
error_type DictionaryObject_Contains(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
Determine if collection contains key.
error_type DictionaryObject_Remove(DictionaryObjectHandle *handle, const NameObjectHandle *key)
Remove key-value pair from collection.
Base class for syntactic tokens.
error_type DictionaryObject_Iterator(DictionaryObjectHandle *handle, DictionaryObjectIteratorHandle **result)
Get collection iterator for enumerating all entries.
error_type DictionaryObjectIterator_Release(DictionaryObjectIteratorHandle *handle)
Decrement the internal reference counter.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
This file contains macro declarations for importing and exporting symbols from library boundaries...
error_type DictionaryObject_InsertConst(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle *value)
Insert new key-value pair into collection.
error_type DictionaryObject_Create(DictionaryObjectHandle **result)
Creates a new dictionary instance.
This file contains types and constants used as parameters or return values.
error_type DictionaryObject_Find(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle **result)
Find mapped value for key key.
Represents unique name references in document.
Used for accessing Dictionary elements through iterator interface.
error_type DictionaryObject_Release(DictionaryObjectHandle *handle)
Decrement the internal reference counter.
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31