Vanilla.PDF  1.6.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
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
45
53
62
70
75
80
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
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, boolean_type overwrite);
135
139 VANILLAPDF_API error_type CALLING_CONVENTION DictionaryObject_InsertConst(DictionaryObjectHandle* handle, const NameObjectHandle* key, ObjectHandle* value, boolean_type overwrite);
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 */
This file contains macro declarations for importing and exporting symbols from library boundaries.
This file contains all type forward declarations returned by the library API.
This file contains types and constants used as parameters or return values.
A dictionary object is an associative table containing pairs of objects.
error_type CALLING_CONVENTION DictionaryObject_Contains(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
Determine if collection contains key.
error_type CALLING_CONVENTION DictionaryObject_FromObject(ObjectHandle *handle, DictionaryObjectHandle **result)
Convert ObjectHandle to DictionaryObjectHandle.
error_type CALLING_CONVENTION DictionaryObject_GetSize(DictionaryObjectHandle *handle, size_type *result)
Return size of collection.
error_type CALLING_CONVENTION DictionaryObject_Insert(DictionaryObjectHandle *handle, NameObjectHandle *key, ObjectHandle *value, boolean_type overwrite)
Insert new key-value pair into collection.
error_type CALLING_CONVENTION DictionaryObject_Clear(DictionaryObjectHandle *handle)
Remove all items from the collection.
error_type CALLING_CONVENTION DictionaryObject_Remove(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
Remove key-value pair from collection.
error_type CALLING_CONVENTION DictionaryObject_Find(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle **result)
Find mapped value for key key.
error_type CALLING_CONVENTION DictionaryObject_InsertConst(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle *value, boolean_type overwrite)
Insert new key-value pair into collection.
error_type CALLING_CONVENTION DictionaryObject_ToObject(DictionaryObjectHandle *handle, ObjectHandle **result)
Reinterpret current object as ObjectHandle.
error_type CALLING_CONVENTION DictionaryObject_GetIterator(DictionaryObjectHandle *handle, DictionaryObjectIteratorHandle **result)
Get collection iterator for enumerating all entries.
error_type CALLING_CONVENTION DictionaryObject_Release(DictionaryObjectHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION DictionaryObject_Create(DictionaryObjectHandle **result)
Creates a new dictionary instance.
Used for accessing Dictionary elements through iterator interface.
error_type CALLING_CONVENTION DictionaryObjectIterator_FromUnknown(IUnknownHandle *handle, DictionaryObjectIteratorHandle **result)
Convert IUnknownHandle to DictionaryObjectIteratorHandle.
error_type CALLING_CONVENTION DictionaryObjectIterator_GetKey(DictionaryObjectIteratorHandle *handle, NameObjectHandle **result)
Get key at iterator position.
error_type CALLING_CONVENTION DictionaryObjectIterator_GetValue(DictionaryObjectIteratorHandle *handle, ObjectHandle **result)
Get value at iterator position.
error_type CALLING_CONVENTION DictionaryObjectIterator_IsValid(DictionaryObjectIteratorHandle *handle, boolean_type *result)
Determine if current position is valid.
error_type CALLING_CONVENTION DictionaryObjectIterator_ToUnknown(DictionaryObjectIteratorHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION DictionaryObjectIterator_Release(DictionaryObjectIteratorHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION DictionaryObjectIterator_Next(DictionaryObjectIteratorHandle *handle)
Advances iterator to the next position.
Base class for reference counting.
A name object is an atomic symbol uniquely defined by a sequence of characters.
Base class for syntactic tokens.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62