NAME

break_unit -- break out of loop

PROTOTYPE

unitptr break_unit( unitptr uHost)

ARGUMENTS

unitptr uHost
host unit

RETURN VALUE:

A pointer to the created unit or NULL in the case of an error.

INTERFACE OF CREATED UNIT:

CTL_in[1]:
(control field) a value of 0 disables the unit

EXECUTION OF CREATED UNIT:

When this unit is encountered as an operand of an iterator unit (such as for_loop, iterator, spatial_op ) during exec or adapt, processing of the loop ends and continues at the next unit behind the loop. Thus, this is the NST-equivalent of a break statement. Execution of a break_unit outside the scope of a loop is treated as an error.

NOTE:

The NST operations ctrl_unit, load_unit and save_unit are not affected by a return_unit. The NST switch_unit contains implicit breaks after each case unit; so here, unlike C, no break_unit is expected.

FILE

/local/homes/rhaschke/nst7/man/../o.linx86//../nstsrc/nst_stdr.c