RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TAdapterSubComponent.StartIterator Method

Makes the first child item with a variable name the current object.

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

StartIterator is part of the support that allows server-side script to use an enumerator to iterate over all the child items in the collection. This method is called to begin iterating over the items in the list. After a call to StartIterator, the GetCurrentObject method returns the first item in the VariablesInUse list. 

OwnerData is a pointer to object-specific information returned that should be passed to the NextIteration or EndIterator method. TAdapterSubComponent does not use the OwnerData parameter. 

StartIterator returns true if it successfully moves to the first item, false if the VariablesInUse property does not list any items. 

 

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!