Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
DictionaryObjectHandle Class Reference

A dictionary object is an associative table containing pairs of objects. More...

Inheritance diagram for DictionaryObjectHandle:
ObjectHandle IUnknownHandle
error_type CALLING_CONVENTION DictionaryObject_Create (DictionaryObjectHandle **result)
 Creates a new dictionary instance.
 
error_type CALLING_CONVENTION DictionaryObject_GetSize (DictionaryObjectHandle *handle, size_type *result)
 Return size of 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_TryFind (DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result, ObjectHandle **result_object)
 Find mapped value for key key, however does not return an error in case the entry is missing.
 
error_type CALLING_CONVENTION DictionaryObject_Contains (DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
 Determine if collection contains key.
 
error_type CALLING_CONVENTION DictionaryObject_GetIterator (DictionaryObjectHandle *handle, DictionaryObjectIteratorHandle **result)
 Get collection iterator for enumerating all entries.
 
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_Clear (DictionaryObjectHandle *handle)
 Remove all items from the 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_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_FromObject (ObjectHandle *handle, DictionaryObjectHandle **result)
 Convert ObjectHandle to DictionaryObjectHandle.
 
error_type CALLING_CONVENTION DictionaryObject_Release (DictionaryObjectHandle *handle)
 Decrement the internal reference counter.
 

Additional Inherited Members

- Public Member Functions inherited from ObjectHandle
error_type CALLING_CONVENTION Object_GetObjectType (ObjectHandle *handle, ObjectType *result)
 Get derived type of current object.
 
- Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

A dictionary object is an associative table containing pairs of objects.

Examples
extract.c.

Friends And Related Symbol Documentation

◆ DictionaryObject_GetIterator()

error_type CALLING_CONVENTION DictionaryObject_GetIterator ( DictionaryObjectHandle * handle,
DictionaryObjectIteratorHandle ** result )
related

Get collection iterator for enumerating all entries.

Modifying collection may invalidate this handle.

◆ DictionaryObject_InsertConst()

error_type CALLING_CONVENTION DictionaryObject_InsertConst ( DictionaryObjectHandle * handle,
const NameObjectHandle * key,
ObjectHandle * value,
boolean_type overwrite )
related

Insert new key-value pair into collection.

◆ DictionaryObject_Release()

error_type CALLING_CONVENTION DictionaryObject_Release ( DictionaryObjectHandle * handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release

The documentation for this class was generated from the following file: