Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_fp_setretlen() accessor function sets the length of a return value of a user-defined function from its associated MI_FPARAM structure.

void mi_fp_setretlen(fparam_ptr, ret_pos, ret_len)

MI_FPARAM *fparam_ptr;

mi_integer ret_pos;

mi_integer ret_len;

fparam_ptr	is a pointer to the associated MI_FPARAM structure.
ret_pos	is the index position into the return-length array for the return value whose length you want to set. For C user-defined functions, the only valid value is 0.
ret_len	is the length, in bytes, to set for the ret_pos+1 return value.

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

The mi_fp_setretlen() function sets the length of the function return value at position ret_pos in the MI_FPARAM structure that fparam_ptr references. The MI_FPARAM structure stores information about return-value lengths in the zero-based return-length array.

To set information for the nth return value, use a ret_pos value of n-1. For example, the following call to mi_fp_setretlen() sets the length to 4 bytes for the first return value of the my_func() UDR, with which fparam1 is associated:

mi_integer my_func(...., fparam1)
	

	MI_FPARAM *fparam1;
{
	

	mi_fp_setretlen(fparam1, 0, 4);


Important: C user-defined functions always have only one return value. 

None.

See the descriptions of the following functions: mi_fp_arglen(), mi_fp_setarglen(), mi_fp_setretprec(), mi_fp_setretscale(), mi_fp_setrettype(), and mi_fp_setreturnisnull().