Iterator_Window

 

Iterate among the windows.

 

 

Syntax

 

SliceO_Window * Iterator_Window(

          char iter_id,

          char flag=0

) ;

 

 

Parameters

 

iter_id

Index of the iterator you want to use.  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.

 

flag

Condition for looking only at specific windows.

The accepted values are:

 

ITER_FLAG_VISIBLE

Only visible windows are returned

 

ITER_FLAG_SELECT

Only the selected window is returned

 

 

Return value

 

This function return a pointer to a window

 

 

Remarks

 

 

Requirements

 

Header:

          sliceO_include.hpp

 

 

Library:

          sliceO_Structures.lib

 

 

Example

 

          if ( Iterator_Init( ITERATOR_USER_1, "Demo Iterator" ) ) {

 

                    while ( SliceO_Window *window = Iterator_Window( ITERATOR_USER_1, NULL ) ) {

                              ...

                    }

                    Iterator_End( ITERATOR_USER_1 ) ;

          }

 

See also

 

Iterator_Init

Iterator_End