The mi_fp_setarglen() function

The mi_fp_setarglen() accessor function sets the length of an argument of a user-defined routine in its associated MI_FPARAM structure.

Syntax

void mi_fp_setarglen(fparam_ptr, arg_pos, arg_len)
   MI_FPARAM *fparam_ptr;
   mi_integer arg_pos;
   mi_integer arg_len;
fparam_ptr
A pointer to the associated MI_FPARAM structure.
arg_pos
The index position into the argument-length array for the argument whose length you want to set.
arg_len
The length, in bytes, to set for the arg_pos+1 argument.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The mi_fp_setarglen() function sets the length of the routine argument at position arg_pos in the MI_FPARAM structure that fparam_ptr references. The MI_FPARAM structure stores information about the lengths of routine arguments in the zero-based argument-length array. To set information for the nth argument, use an arg_pos value of n-1. For example, the following call to mi_fp_setarglen() sets the length for the third argument of the my_func() UDR, with which fparam1 is associated:
mi_integer my_func(..., fparam1)
   ...
   MI_FPARAM *fparam1;
{
   ...
   mi_fp_setarglen(fparam1, 2, 4);

For more information about argument information in an MI_FPARAM structure, see the HCL OneDB™ DataBlade® API Programmer's Guide.

Return values

None.