The mi_fp_setcolid() function

The mi_fp_setcolid() accessor function sets the column identifier of the column that is associated with the user-defined routine from its MI_FPARAM structure.

Syntax

void mi_fp_setcolid(fparam_ptr, value)
   MI_FPARAM *fparam_ptr;
   mi_integer value;

fparam_ptr: A pointer to the associated MI_FPARAM structure.
value: The intended value of the column.

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_setcolid() function sets the column identifier for the user-defined routine that is associated with the fparam_ptr MI_FPARAM structure. The column identifier is the location of the column within the row structure (with the first column starting at offset 0). The column identifier and row structure identify the column with which the UDR invocation is associated. To set the row structure, use the mi_fp_setrow() function.

This function is valid only when you need to create a smart large object in either of the following UDRs:

Another iteration of the UDR
A UDR that is called through the Fastpath interface

For either case, you can use mi_fp_setcolid() to set the column identifier in the MI_FPARAM structure of the UDR before the UDR is called. When this UDR executes, it can obtain the column identifier from its MI_FPARAM structure and use it in conjunction with the mi_lo_colinfo_by_ids() function to obtain the correct storage characteristics for the smart large object it needs to create.

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

Return values

None.