informix
Informix DataBlade API Programmer's Manual
DataBlade API Function Descriptions

mi_fp_nrets()

The mi_fp_nrets() accessor function obtains the number of return values for the UDR from its associated MI_FPARAM structure.

Syntax

Usage

You can use the mi_fp_nrets() function with the DataBlade API functions that obtain information about each return value of the UDR (such as mi_fp_rettype() and mi_fp_returnisnull()). For example, the following call to mi_fp_nrets() obtains the number of return values from the MI_FPARAM structure that fparam1 identifies and uses the value in a loop to obtain the length of each return value:

Important: C user-defined functions have only one return value.

Return Values

>=0 is the number of values that the UDR returns.
MI_ERROR indicates that the function was not successful.

Related Topics

See the descriptions of the following functions: mi_fp_nargs(), mi_fp_retlen(), mi_fp_retprec(), mi_fp_retscale(), mi_fp_rettype(), mi_fp_returnisnull(), and mi_fp_setnrets().


Informix DataBlade API Programmer's Manual, Version 9.2
Copyright © 1999, Informix Software, Inc. All rights reserved