xpxTerminateXpxIterator

FUNCTION xpxTerminateXpxIterator (iteratorId : GENERIC)
                                  status     : INTEGER;

The xpxTerminateXpxIterator is used to terminate an iterator in the current iteration process. An iteration process is defined by a FROM clause, a COMPOSE declaration or a FROM statement. The iterator argument must be specified by the variable_id part of the extended entity reference that defines the actual iterator to be terminated. The current iteration will continue until it ends, i.e., until END_MAP, END_COMPOSE or END in the actual MAP declaration, COMPOSE declaration or FROM statement respectively. If the target iterator is the outmost iterator, i.e., the iterator first in the actual FROM clause or the actual FROM statement or the COMPOSE entity, the complete iteration process will terminate. If the target iterator is an inner iterator then the target iterator and all more inner iterators will terminate. Termination of an iterator means that the next iteration will start on the very first element in the terminated iterator, i.e., all elements in the iterator after the current element will be skipped.

Arguments

Return Value

Options

Example

MAP example_of_using_xpxTerminateXpxIterator FOR t:target::anEntity;
FROM (s_a:source::entityA, s_b:source::EntityB)
WHEN (TRUE);
BEGIN_MAP
 ...
 IF (s_a.attrVal = s_b.attrVal) THEN
...
  XpxTerminateXpxIterator(s_b);
 END_IF;
 ...
END_MAP;

See also