RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
IIteratorSupport.StartIterator Method

Positions the object on its first item and starts the iteration process.

Pascal
function StartIterator(var OwnerData: Pointer): Boolean;
C++
__fastcall Boolean StartIterator(void * OwnerData);

Server-side script calls StartIterator to begin iterating over the object's items. 

OwnerData returns a pointer to information that the object can use to influence the iteration process. StartIterator initializes this information to reflect what ever information the object needs to communicate to itself as it advances over its items. This pointer is then passed to the next call to the NextIteration or EndIterator method.  

StartIterator returns true if it successfully moves to the first item, false if there are no items to iterate. 

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!