The mi_fp_setrow() function

The mi_fp_setrow() accessor function sets the row structure that is associated with the user-defined routine in its associated MI_FPARAM structure.

Syntax

void mi_fp_setrow(fparam_ptr, row_struc)
   MI_FPARAM *fparam_ptr;
   MI_ROW *row_struct
fparam_ptr
A pointer to the associated MI_FPARAM structure.
row_struct
A pointer to the row structure to store in the MI_FPARAM structure.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes
Important: This advanced function can adversely affect your UDR if you use the function incorrectly. Use it only when no regular DataBlade® API function can perform the task you need done.

Usage

The mi_fp_setrow() function sets the row structure for the user-defined routine that is associated with the fparam_ptr MI_FPARAM structure. The row structure contains the column values of the row with which the UDR invocation is associated. The row structure and column identifier identify the column with which the UDR invocation is associated. To set the column identifier to a column within the row structure, use the mi_fp_setcolid() function.

This function is valid only to create a smart large object either in another iteration of a UDR or in a UDR that is called through the Fastpath interface. In either case, you can use mi_fp_setrow() to set the row structure in the MI_FPARAM structure of a UDR before the UDR is called. When the UDR executes, it can obtain the row structure from its MI_FPARAM structure and use this row structure in conjunction with the mi_lo_colinfo_by_ids() function to obtain the correct storage characteristics for the creation of a smart large object.

For more information about UDR information in an MI_FPARAM structure, see the Informix® DataBlade® API Programmer's Guide.

Return values

None.