The mi_fp_usr_fparam() function

The mi_fp_usr_fparam() accessor function determines whether the database server or the developer has allocated the specified MI_FPARAM structure.

Syntax

mi_boolean mi_fp_usr_fparam (MI_FPARAM fparam_ptr)
   MI_FPARAM *fparam_ptr;
fparam_ptr
A pointer to the associated MI_FPARAM structure.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The Fastpath interface uses an MI_FPARAM structure to hold information about the UDR or cast function to execute. This MI_FPARAM structure can be allocated in one of two ways:
  • By a Fastpath look-up function (mi_cast_get(), mi_func_desc_by_typeid(), mi_routine_get(), mi_routine_get_by_typeid(), or mi_td_cast_get()), as part of the function descriptor for the routine to execute
  • By the developer, with the mi_fparam_allocate() or mi_fparam_copy() function

The mi_fp_usr_fparam() function determines which of these two methods was used to allocate the MI_FPARAM structure that fparam_ptr references.

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

Return values

MI_TRUE
The MI_FPARAM structure, which fparam_ptr references, is a user-allocated structure.
MI_FALSE
The MI_FPARAM structure, which fparam_ptr references, was allocated by the database server.
MI_ERROR
The function was not successful.