Programming Reference: ODPlatformTypeListIterator

# Programming Reference

## ODPlatformTypeListIterator

Class Definition File | PfTLItr.idl
Class C++ Binding | PfTLItr.xh

Class Hierarchy

    SOMObject
       ODObject
          ODPlatformTypeListIterator

Description

An object of the ODPlatformTypeListIterator class provides access to each element of a platform type list.

You use a platform type-list iterator to apply an operation to each element of a platform type list.

Your part creates a platform type-list iterator object by calling the platform type list object's CreatePlatformTypeListIterator method, which returns a reference to a platform type-list iterator object. Platform type-list iterator objects are not required by any OpenDoc method. However, your part can internally use these objects.

While you are using a platform type-list iterator, you should not modify or delete the platform type list that created it. Your must postpone adding elements to or removing elements from the platform type list until after you have deleted the iterator.

For more information on accessing objects through iterators, see the chapter on OpenDoc runtime features in the OpenDoc Programming Guide.

Methods

The methods defined by the ODPlatformTypeListIterator class include:

- First
- IsNotComplete
- Next

Overridden Methods | There are no methods overridden by the ODPlatformTypeListIterator class.

### First

This method begins the iteration and returns the first element in the platform type list that created this platform type-list iterator.

Signature

    ODPlatformType First ()

Parameters

None.

Returns

rv (ODPlatformType) - returns

  The first element in the platform type list or kODNULL if the platform type list is empty.

Remarks

Your part must call this method before calling this platform type-list iterator's IsNotComplete method for the first time. This method may be called multiple times; each time, it resets the iteration.

Exception Handling

kODErrIteratorOutOfSync | The platform type list was modified while the iteration was in progress.

### IsNotComplete

This method indicates whether the iteration is incomplete.

Signature

    ODBoolean IsNotComplete ()

Parameters

None.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the iteration is incomplete.

  kODTrue | The iteration is incomplete.
  kODFalse | The iteration is complete.

Remarks

Your part calls this method to test whether more elements remain in the platform type list. This method returns kODTrue if the preceding call to the First or Next method found an element. This method returns kODFalse when you have examined all the elements (that is, when the previous call to First or Next returned kODNULL). If the platform type list that created this iterator is empty, this method always returns kODFalse.

Exception Handling

kODErrIteratorNotInitialized | This method was called before calling the First or Next method to begin the iteration.
kODErrIteratorOutOfSync | The platform type list was modified while the iteration was in progress.

### Next

This method returns the next element in the platform type list that created this platform type-list iterator.

Signature

    ODPlatformType Next ()

Parameters

None.

Returns

rv (ODPlatformType) - returns

  The next element in the platform type list or kODNULL if you have reached the end of the platform type list.

Remarks

If your part calls this method before calling this platform type-list iterator's First method to begin the iteration, then this method works the same as calling the First method.

Exception Handling

kODErrIteratorOutOfSync | The platform type list was modified while the iteration was in progress.

[ Top | Previous | Next | Contents | Index | Documentation Homepage ]