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

mi_fp_arglen()

The mi_fp_arglen() accessor function obtains the length of an argument of a user-defined routine from its associated MI_FPARAM structure.

Syntax

Usage

The mi_fp_arglen() function obtains the length of the routine argument at position arg_pos from the MI_FPARAM structure that fparam_ptr references. The MI_FPARAM structure stores information about the lengths of routine arguments in the zero-based argument-length array. To obtain information about the nth argument, use an arg_pos value of n-1. For example, the following call to mi_fp_arglen() obtains the length for the third argument of the my_func() UDR, with which fparam1 is associated:

Return Values

>=0 is the length, in bytes, of the argument at position arg_pos.
MI_ERROR indicates that the function was not successful.

Related Topics

See the descriptions of the following functions: mi_fp_argisnull(), mi_fp_argprec(), mi_fp_argscale(), mi_fp_argtype(), mi_fp_retlen(), mi_fp_setarglen(), and mi_fp_setretlen().


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