AIDictionaryIteratorSuite Struct Reference

Use these functions to iterate through the contents of a dictionary. More...

#include <AIDictionary.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	AddRef )(AIDictionaryIterator iterator)
	Increments the reference count of an iterator.
AIAPI ai::int32(*	Release )(AIDictionaryIterator iterator)
	Frees the memory associated with an iterator when it is no longer used (the reference count is 0).
AIAPI AIBoolean(*	IsValid )(AIDictionaryIterator iterator)
	Reports whether an iterator is valid.
AIAPI AIErr(*	Copy )(AIDictionaryIterator iterator, AIDictionaryIterator from)
	Makes an iterator refer to the same dictionary entry as another iterator.
AIAPI AIErr(*	Clone )(AIDictionaryIterator iterator, AIDictionaryIterator *clone)
	Creates a new iterator which is a copy of another iterator.
AIAPI AIBoolean(*	IsEqual )(AIDictionaryIterator iterator1, AIDictionaryIterator iterator2)
	Reports whether two iterators refer to the same entry of the same dictionary.
AIAPI AIBoolean(*	AtEnd )(AIDictionaryIterator iterator)
	Reports whether an iterator has exhausted all dictionary entries.
AIAPI void(*	Next )(AIDictionaryIterator iterator)
	Advance an iterator's current-entry reference to the next entry.
AIAPI void(*	Prev )(AIDictionaryIterator iterator)
	Back up an iterator's current-entry reference to the previous entry.
AIAPI AIDictKey(*	GetKey )(AIDictionaryIterator iterator)
	Retrieves the key of an iterator's current entry.
AIAPI AIEntryRef(*	GetEntry )(AIDictionaryIterator iterator)
	Retrieves a dictionary entry for the dictionary iterator (Note that this function returns an entry object, not an error code.

---

Detailed Description

Use these functions to iterate through the contents of a dictionary.

Obtain the iterator object with AIDictionarySuite::Begin(), and get the number of entries with AIDictionarySuite::Size().

Iterators are reference counted. The initial count is 1.

---

Member Data Documentation

AIAPI ai::int32(* AIDictionaryIteratorSuite::AddRef)(AIDictionaryIterator iterator)

Increments the reference count of an iterator.

Parameters:

iterator

The iterator object.

AIAPI AIBoolean(* AIDictionaryIteratorSuite::AtEnd)(AIDictionaryIterator iterator)

Reports whether an iterator has exhausted all dictionary entries.

(Note that this function returns a boolean value, not an error code.)

Parameters:

iterator

The iterator object.

Returns:

True if the iteration has reached the end.

Referenced by ai::Dictionary::begin(), and ai::Dictionary::iterator::operator++().

AIAPI AIErr(* AIDictionaryIteratorSuite::Clone)(AIDictionaryIterator iterator, AIDictionaryIterator *clone)

Creates a new iterator which is a copy of another iterator.

Parameters:

	iterator	The iterator object to copy.
	clone	[out] A buffer in which to return the new iterator object.

AIAPI AIErr(* AIDictionaryIteratorSuite::Copy)(AIDictionaryIterator iterator, AIDictionaryIterator from)

Makes an iterator refer to the same dictionary entry as another iterator.

Parameters:

	iterator	The iterator object.
	from	Another iterator object, whose current entry reference is copied.

AIAPI AIEntryRef(* AIDictionaryIteratorSuite::GetEntry)(AIDictionaryIterator iterator)

Retrieves a dictionary entry for the dictionary iterator (Note that this function returns an entry object, not an error code.

)

Parameters:

iterator

The iterator object.

Returns:

The entry object or a null entry if the iterator is at the end

Referenced by ai::Dictionary::iterator::operator*().

AIAPI AIDictKey(* AIDictionaryIteratorSuite::GetKey)(AIDictionaryIterator iterator)

Retrieves the key of an iterator's current entry.

(Note that this function returns a key object, not an error code.)

Parameters:

iterator

The iterator object.

Returns:

The key object.

Referenced by ai::Dictionary::iterator::operator*().

AIAPI AIBoolean(* AIDictionaryIteratorSuite::IsEqual)(AIDictionaryIterator iterator1, AIDictionaryIterator iterator2)

Reports whether two iterators refer to the same entry of the same dictionary.

(Note that this function returns a boolean value, not an error code.)

Parameters:

	iterator1	The first iterator.
	iterator2	The second iterator.

Returns:

True if both iterators refer to the same entry of the same dictionary.

Referenced by ai::Dictionary::iterator::operator==().

AIAPI AIBoolean(* AIDictionaryIteratorSuite::IsValid)(AIDictionaryIterator iterator)

Reports whether an iterator is valid.

(Not yet implemented)

Parameters:

iterator

The iterator object.

Returns:

True if the iterator is valid, false if the dictionary has changed due to insertion or deletion of elements since the iterator was constructed.

AIAPI void(* AIDictionaryIteratorSuite::Next)(AIDictionaryIterator iterator)

Advance an iterator's current-entry reference to the next entry.

(Note that this function does not return an error code. Use AtEnd() to determine if the iterator has exhausted all entries.)

Parameters:

iterator

The iterator object.

Referenced by ai::Dictionary::iterator::operator++().

AIAPI void(* AIDictionaryIteratorSuite::Prev)(AIDictionaryIterator iterator)

Back up an iterator's current-entry reference to the previous entry.

(Note that this function does not return an error code. Calling it on the first entry has undefined results.)

Parameters:

iterator

The iterator object.

AIAPI ai::int32(* AIDictionaryIteratorSuite::Release)(AIDictionaryIterator iterator)

Frees the memory associated with an iterator when it is no longer used (the reference count is 0).

Parameters:

iterator

The iterator object. Upon return, this reference is no longer valid.

---

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

• AIDictionary.h