IIteratorSupport Interface

IIteratorSupport is the interface that allows server-side script to iterate over the items of an adapter or one of its child objects.

Class Hierarchy

Pascal

IIteratorSupport = interface;

C++

__interface IIteratorSupport;

File

SiteComp

Description

Server-side script uses the IIteratorSupport interface to enumerate the items of an adapter or one of its sub-components. When the server-side script includes an enumerator, the WebSnap application automatically generates calls to the IIteratorSupport methods of the object that contains the items to enumerate.

The WebSnap application first calls the StartIterator method to position the object on its first item. To advance to the next item, the application calls the NextIteration method. Finally, the application calls the EndIterator method to signal the end of the iteration.

Each object that implements IIteratorSupport determines the items over which it iterates. For example, if the object is an adapter, these can be records or pages that the adapter uses to group information, or name/value pairs that the adapter represents. If the object is a list of fields or actions, these can be the fields or actions in the list. If the object is an adapter field, these can be the possible values of the field. If the object is an adapter action, these can be the commands the action can execute.

Note: In C++, method declarations that use IIteratorSupport use the _di_IIteratorSupport type instead. This type is a DelphiInterface wrapper around the IIteratorSupport interface:

Note: typedef System::DelphiInterface< IIteratorSupport > _di_IIteratorSupport;