Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_fp_setisdone() accessor function sets the iterator-completion flag for an iterator function in its associated MI_FPARAM structure.

void mi_fp_setisdone(fparam_ptr, flag)

MI_FPARAM *fparam_ptr;

mi_integer flag;

fparam_ptr	is a pointer to the associated MI_FPARAM structure.
flag	is the integer iterator-completion flag to store in the MI_FPARAM structure, which indicates whether the end condition for the iterator function was reached.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

Use the mi_fp_setisdone() function to tell the database server whether the current iterator function has reached its end condition. An end condition indicates that the generation of the active set is complete. The database server calls the iterator function with the SET_RETONE iterator-status value as long as the end condition has not been set.

Valid values for the iterator-completion flag argument are as follows.

Important: Make sure that you include a call to the mi_fp_setisdone() function within your iterator function that sets the iterator-completion flag to one (1). Without this call, the database server never reaches an end condition for the iterations, which causes it to iterate the function in an infinite loop.

The iterator function does not return a value into the active set once the iterator-completion flag is set to 1.

None.

See the description of the mi_fp_request() function.

For more information on how to create and call iterator functions, see Writing an Iterator Function.