Vanilla.PDF  1.5.2
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, boolean_type* result);
62 
69  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_Next(DictionaryObjectIteratorHandle* handle);
70 
74  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_ToUnknown(DictionaryObjectIteratorHandle* handle, IUnknownHandle** result);
75 
79  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_FromUnknown(IUnknownHandle* handle, DictionaryObjectIteratorHandle** result);
80 
85  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObjectIterator_Release(DictionaryObjectIteratorHandle* handle);
86 
97  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Create(DictionaryObjectHandle** result);
98 
102  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_GetSize(DictionaryObjectHandle* handle, size_type* result);
103 
107  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Find(DictionaryObjectHandle* handle, const NameObjectHandle* key, ObjectHandle** result);
108 
112  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Contains(DictionaryObjectHandle* handle, const NameObjectHandle* key, boolean_type* result);
113 
119  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_GetIterator(DictionaryObjectHandle* handle, DictionaryObjectIteratorHandle** result);
120 
124  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Remove(DictionaryObjectHandle* handle, const NameObjectHandle* key, boolean_type* result);
125 
129  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Clear(DictionaryObjectHandle* handle);
130 
134  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Insert(DictionaryObjectHandle* handle, NameObjectHandle* key, ObjectHandle* value);
135 
139  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_InsertConst(DictionaryObjectHandle* handle, const NameObjectHandle* key, ObjectHandle* value);
140 
144  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_ToObject(DictionaryObjectHandle* handle, ObjectHandle** result);
145 
149  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_FromObject(ObjectHandle* handle, DictionaryObjectHandle** result);
150 
154  VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_Release(DictionaryObjectHandle* handle);
155 
158 #ifdef __cplusplus
159 };
160 #endif
161 
162 #endif /* _C_DICTIONARY_OBJECT_H */
error_type DictionaryObjectIterator_Next(DictionaryObjectIteratorHandle *handle)
Advances iterator to the next position.
error_type DictionaryObjectIterator_ToUnknown(DictionaryObjectIteratorHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
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.
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
error_type DictionaryObject_Insert(DictionaryObjectHandle *handle, NameObjectHandle *key, ObjectHandle *value)
Insert new key-value pair into collection.
error_type DictionaryObject_GetSize(DictionaryObjectHandle *handle, size_type *result)
Return size of collection.
A dictionary object is an associative table containing pairs of objects.
error_type DictionaryObjectIterator_GetValue(DictionaryObjectIteratorHandle *handle, ObjectHandle **result)
Get value at iterator position.
error_type DictionaryObject_FromObject(ObjectHandle *handle, DictionaryObjectHandle **result)
Convert ObjectHandle to DictionaryObjectHandle.
error_type DictionaryObject_Contains(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
Determine if collection contains key.
Base class for syntactic tokens.
error_type DictionaryObject_Clear(DictionaryObjectHandle *handle)
Remove all items from the collection.
error_type DictionaryObjectIterator_Release(DictionaryObjectIteratorHandle *handle)
Decrement the internal reference counter.
error_type DictionaryObjectIterator_FromUnknown(IUnknownHandle *handle, DictionaryObjectIteratorHandle **result)
Convert IUnknownHandle to DictionaryObjectIteratorHandle.
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_ToObject(DictionaryObjectHandle *handle, ObjectHandle **result)
Reinterpret current object as ObjectHandle.
error_type DictionaryObject_InsertConst(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle *value)
Insert new key-value pair into collection.
error_type DictionaryObject_GetIterator(DictionaryObjectHandle *handle, DictionaryObjectIteratorHandle **result)
Get collection iterator for enumerating all entries.
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 DictionaryObjectIterator_IsValid(DictionaryObjectIteratorHandle *handle, boolean_type *result)
Determine if current position is valid.
error_type DictionaryObject_Find(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle **result)
Find mapped value for key key.
A name object is an atomic symbol uniquely defined by a sequence of characters.
Base class for reference counting.
Used for accessing Dictionary elements through iterator interface.
error_type DictionaryObject_Remove(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
Remove key-value pair from collection.
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