Iterator

Close an iterator

Syntax

void Iterator_End(

char iter_id

) ;

Parameters

iter_id

Index of the iterator you want to close. There can only be one iterator open at the same time for each index. There are MAX_ITERATOR_ID id, but only ITERATOR_USER_1 and ITERATOR_USER_2 should be used in user functions.

Return value

This function does not return a value.

Remarks

Requirements

Header:

sliceO_include.hpp

Library:

sliceO_Structures.lib

Example

// --- start an iterator ---

if ( Iterator_Init( ITERATOR_USER_1, "Name of this function" ) ) {

// --- now go through all the selected frames ---

while( SliceO_Frame *frame = (SliceO_Frame *) Iterator_Class( ITERATOR_UESR_1, CLASS_TYPE_FRAME, Cur_Window, ITER_FLAG_SELECT ) ) {

// --- frame is now a pointer to one of the selected frames ---

...

}

Iterator_End( ITERATOR_USER_1 ) ;

}