DictionaryObjectIteratorHandle Class Reference

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

Inheritance diagram for 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_Next (DictionaryObjectIteratorHandle *handle)
	Advances iterator to the next position.
error_type CALLING_CONVENTION	DictionaryObjectIterator_ToUnknown (DictionaryObjectIteratorHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	DictionaryObjectIterator_FromUnknown (IUnknownHandle *handle, DictionaryObjectIteratorHandle **result)
	Convert IUnknownHandle to DictionaryObjectIteratorHandle.
error_type CALLING_CONVENTION	DictionaryObjectIterator_Release (DictionaryObjectIteratorHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

Used for accessing Dictionary elements through iterator interface.

Member Function Documentation

DictionaryObjectIterator_GetKey()

error_type CALLING_CONVENTION DictionaryObjectIterator_GetKey	(	DictionaryObjectIteratorHandle *	handle,
		NameObjectHandle **	result )

Get key at iterator position.

Ensure the iterator is valid.

See also

DictionaryObjectIterator_IsValid

Friends And Related Symbol Documentation

DictionaryObjectIterator_GetValue()

error_type CALLING_CONVENTION 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 CALLING_CONVENTION 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 CALLING_CONVENTION DictionaryObjectIterator_Next ( DictionaryObjectIteratorHandle * handle )

related

Advances iterator to the next position.

Ensure the iterator is valid.

See also

DictionaryObjectIterator_IsValid

DictionaryObjectIterator_Release()

error_type CALLING_CONVENTION 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:

• c_dictionary_object.h