DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home
Contents
Index
Master Index
New Book
mi_fp_usr_fparam()
The
mi_fp_usr_fparam()
accessor function returns the
mi_fp_usr_fparam
value from an associated
MI_FPARAM
structure. This value indicates whether the structure was allocated on behalf of a user-defined routine or by the database server.
Syntax
mi_boolean mi_fp_usr_fparam (MI_FPARAM
fparamPtr
)
MI_FPARAM *fparamPtr;
fparamPtr
is a pointer to the associated
MI_FPARAM
structure.
Valid in Client Application?
Valid in Server Routine?
No
Yes
Usage
The
mi_fp_usr_fparam
value in an
MI_FPARAM
structure indicates whether the structure was allocated on behalf of a user-defined routine. If the structure was allocated for a user-defined routine, the
fp_usr_fparam
value is
MI_TRUE
. For an
MI_FPARAM
structure that was allocated by the database server, this value is
MI_FALSE
.
Return Values
On success, the
mi_fp_usr_fparam()
function returns
MI_TRUE
or
MI_FALSE. On
failure, it returns
MI_ERROR.
Related Topics
For additional information, see the descriptions of the following functions:
mi_fparam_allocate()
,
mi_fparam_copy()
, and
mi_fparam_free()
.
DataBlade API Programmer's Manual
, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.
