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

Used for accessing Dictionary elements through iterator interface. More...

Inheritance diagram for DictionaryObjectIteratorHandle:
IUnknownHandle
error_type DictionaryObjectIterator_GetKey (DictionaryObjectIteratorHandle *handle, NameObjectHandle **result)
 Get key at iterator position. More...
 
error_type DictionaryObjectIterator_GetValue (DictionaryObjectIteratorHandle *handle, ObjectHandle **result)
 Get value at iterator position. More...
 
error_type DictionaryObjectIterator_IsValid (DictionaryObjectIteratorHandle *handle, boolean_type *result)
 Determine if current position is valid. More...
 
error_type DictionaryObjectIterator_Next (DictionaryObjectIteratorHandle *handle)
 Advances iterator to the next position. More...
 
error_type DictionaryObjectIterator_ToUnknown (DictionaryObjectIteratorHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type DictionaryObjectIterator_FromUnknown (IUnknownHandle *handle, DictionaryObjectIteratorHandle **result)
 Convert IUnknownHandle to DictionaryObjectIteratorHandle.
 
error_type DictionaryObjectIterator_Release (DictionaryObjectIteratorHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Used for accessing Dictionary elements through iterator interface.

Member Function Documentation

◆ DictionaryObjectIterator_GetKey()

error_type DictionaryObjectIterator_GetKey ( DictionaryObjectIteratorHandle handle,
NameObjectHandle **  result 
)

Get key at iterator position.

Ensure the iterator is valid.

See also
DictionaryObjectIterator_IsValid

Friends And Related Function Documentation

◆ DictionaryObjectIterator_GetValue()

error_type DictionaryObjectIterator_GetValue ( DictionaryObjectIteratorHandle handle,
ObjectHandle **  result 
)
related

Get value at iterator position.

Ensure the iterator is valid.

See also
DictionaryObjectIterator_IsValid

◆ DictionaryObjectIterator_IsValid()

error_type DictionaryObjectIterator_IsValid ( DictionaryObjectIteratorHandle handle,
boolean_type result 
)
related

Determine if current position is valid.

Invalid position may mean that iterator moved past the end of the collection, as well as the collection was modified.

Any other operation except THIS will fail on invalid iterator.

◆ DictionaryObjectIterator_Next()

error_type DictionaryObjectIterator_Next ( DictionaryObjectIteratorHandle handle)
related

Advances iterator to the next position.

Ensure the iterator is valid.

See also
DictionaryObjectIterator_IsValid

◆ DictionaryObjectIterator_Release()

error_type DictionaryObjectIterator_Release ( DictionaryObjectIteratorHandle 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: