INFORMIX
DataBlade API Programmer's Manual
Chapter 4: Using the MI_FPARAM Structure
Home Contents Index Master Index New Book

Accessing MI_FPARAM Values

Important: The MI_FPARAM structure is an opaque structure to DataBlade API functions. That is, you should not access its internal fields directly. Informix does not guarantee that the internal structure of MI_FPARAM will not change in future releases. Therefore, to create portable code, always use the accessor functions for this structure to obtain and store values.

Use the following DataBlade API accessor functions to get values from or store values in the MI_FPARAM structure. Chapter 12 describes each function.

(1 of 2)

Functions MI_FPARAM Information

mi_fp_funcstate()
mi_fp_setfuncstate()

Pointer to a function-specific structure that holds state information during routine execution

mi_fp_request()

Indicates the operation being performed on this call to the routine in MI_FPARAM.

Values are: SET_INIT, SET_RETONE, SET_END, SET_INVALID

mi_fp_nargs()
mi_fp_setnargs()

Number of arguments for routine in MI_FPARAM

mi_fp_arglen()
mi_fp_setarglen()

Array that stores the length of each argument

mi_fp_argprec()
mi_fp_setargprec()

Array that stores the precision of each argument

mi_fp_argscale()
mi_fp_setargscale()

Array that stores the scale of each argument

mi_fp_argisnull()
mi_fp_setargisnull()

Array that indicates if the nth+1 argument is null

mi_fp_argtype()
mi_fp_setargtype()

Array that contains the data-type constants for each of the arguments of the routine in the MI_FPARAM structure

mi_fp_nrets()
mi_fp_setnrets()

Number of return values for routine in MI_FPARAM (always 1 for C routines)

mi_fp_retlen()
mi_fp_setretlen()

The length of return value

mi_fp_retprec()
mi_fp_setretprec()

The precision of the return value

mi_fp_argscale()
mi_fp_setargscale()

The scale of the return value

mi_fp_rettype()
mi_fp_setrettype()

Data-type constant for nth+1 return value of routine in MI_FPARAM (n=0 for all C routines)

mi_fp_returnisnull()
mi_fp_setreturnisnull()

MI_TRUE or MI_FALSE to indicate whether nth return value of routine in MI_FPARAM is null (n=0 for all C routines)

mi_fp_setisdone()

MI_TRUE or MI_FALSE to indicate whether function has finished returning rows of data

mi_fp_setfuncid()

Function ID of the routine in the MI_FPARAM structure

The MI_FPARAM structure allows you to save memory across function calls. The following types of DataBlade functions must accept an additional parameter that is a pointer to an MI_FPARAM structure when it needs to perform the following tasks:




DataBlade API Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.