Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
List of all members
DictionaryObjectHandle Class Reference

Represents key-value map. More...

Inheritance diagram for DictionaryObjectHandle:
ObjectHandle IUnknownHandle
error_type DictionaryObject_Create (DictionaryObjectHandle **result)
 Creates a new dictionary instance.
 
error_type DictionaryObject_Find (DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle **result)
 Find mapped value for key key.
 
error_type DictionaryObject_Contains (DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result)
 Determine if collection contains key.
 
error_type DictionaryObject_Iterator (DictionaryObjectHandle *handle, DictionaryObjectIteratorHandle **result)
 Get collection iterator for enumerating all entries. More...
 
error_type DictionaryObject_Remove (DictionaryObjectHandle *handle, const NameObjectHandle *key)
 Remove key-value pair from collection.
 
error_type DictionaryObject_Insert (DictionaryObjectHandle *handle, NameObjectHandle *key, ObjectHandle *value)
 Insert new key-value pair into collection.
 
error_type DictionaryObject_InsertConst (DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle *value)
 Insert new key-value pair into collection. More...
 
error_type DictionaryObject_Release (DictionaryObjectHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

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

Detailed Description

Represents key-value map.

Examples:
extract.c.

Friends And Related Function Documentation

◆ DictionaryObject_Iterator()

error_type DictionaryObject_Iterator ( DictionaryObjectHandle handle,
DictionaryObjectIteratorHandle **  result 
)
related

Get collection iterator for enumerating all entries.

Modifying collection may invalidate this handle.

◆ DictionaryObject_InsertConst()

error_type DictionaryObject_InsertConst ( DictionaryObjectHandle handle,
const NameObjectHandle key,
ObjectHandle value 
)
related

Insert new key-value pair into collection.

Examples:
extract.c.

◆ DictionaryObject_Release()

error_type 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
Examples:
extract.c.

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