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

mi_fp_setretprec()

The mi_fp_setretprec() accessor function sets the precision of a return value of a user-defined function in its associated MI_FPARAM structure.

Syntax

Usage

The mi_fp_setretprec() function sets the precision of the function return value at position ret_pos in the MI_FPARAM structure that fparam_ptr references.

The precision is an attribute of the data type that represents the total number of digits the routine return value can hold, as follows.

Data Type Meaning
DECIMAL, MONEY Number of significant digits in the fixed-point or floating-point (DECIMAL) column
DATETIME, INTERVAL Number of digits that are stored in the date and/or time column with the specified qualifier
Character,
Varying-character
Maximum number of characters in the column

The MI_FPARAM structure stores information about the precision of function return values in the zero-based return-precision array. To set information for the nth return value, use a ret_pos value of n-1.

For example, the following call to mi_fp_setretprec() sets the precision of 10 for the first return value of the my_func() UDR, with which fparam1 is associated:

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

Return Values

None.

Related Topics

See the descriptions of the following functions: mi_fp_argprec(), mi_fp_setargprec(), mi_fp_setretlen(), mi_fp_setretscale(), mi_fp_setrettype(), and mi_fp_setreturnisnull().


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