DestinationNameTreeIteratorHandle Class Reference

Iterator for traversing all entries in a DestinationNameTreeHandle. More...

Inheritance diagram for DestinationNameTreeIteratorHandle:

error_type CALLING_CONVENTION	DestinationNameTreeIterator_GetKey (DestinationNameTreeIteratorHandle *handle, StringObjectHandle **result)
	Get the key (name) at the current iterator position.
error_type CALLING_CONVENTION	DestinationNameTreeIterator_GetValue (DestinationNameTreeIteratorHandle *handle, DestinationHandle **result)
	Get the value (destination) at the current iterator position.
error_type CALLING_CONVENTION	DestinationNameTreeIterator_IsValid (DestinationNameTreeIteratorHandle *handle, boolean_type *result)
	Determine if current position is valid.
error_type CALLING_CONVENTION	DestinationNameTreeIterator_Next (DestinationNameTreeIteratorHandle *handle)
	Advances iterator to the next position.
error_type CALLING_CONVENTION	DestinationNameTreeIterator_ToUnknown (DestinationNameTreeIteratorHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	DestinationNameTreeIterator_FromUnknown (IUnknownHandle *handle, DestinationNameTreeIteratorHandle **result)
	Convert IUnknownHandle to DestinationNameTreeIteratorHandle.
error_type CALLING_CONVENTION	DestinationNameTreeIterator_Release (DestinationNameTreeIteratorHandle *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

Iterator for traversing all entries in a DestinationNameTreeHandle.

Member Function Documentation

DestinationNameTreeIterator_GetKey()

error_type CALLING_CONVENTION DestinationNameTreeIterator_GetKey	(	DestinationNameTreeIteratorHandle *	handle,
		StringObjectHandle **	result
	)

Get the key (name) at the current iterator position.

Ensure the iterator is valid.

See also

DestinationNameTreeIterator_IsValid

Friends And Related Symbol Documentation

DestinationNameTreeIterator_GetValue()

error_type CALLING_CONVENTION DestinationNameTreeIterator_GetValue ( DestinationNameTreeIteratorHandle *  handle, DestinationHandle **  result  )

related

Get the value (destination) at the current iterator position.

Ensure the iterator is valid.

See also

DestinationNameTreeIterator_IsValid

DestinationNameTreeIterator_IsValid()

error_type CALLING_CONVENTION DestinationNameTreeIterator_IsValid ( DestinationNameTreeIteratorHandle *  handle, boolean_type *  result  )

related

Determine if current position is valid.

Invalid position may mean that iterator moved past the end or the collection was modified.

Any other operation except THIS will fail on invalid iterator.

DestinationNameTreeIterator_Next()

error_type CALLING_CONVENTION DestinationNameTreeIterator_Next ( DestinationNameTreeIteratorHandle *  handle )

related

Advances iterator to the next position.

Ensure the iterator is valid.

See also

DestinationNameTreeIterator_IsValid

DestinationNameTreeIterator_Release()

error_type CALLING_CONVENTION DestinationNameTreeIterator_Release ( DestinationNameTreeIteratorHandle *  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_destination_name_tree.h