DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home
Contents
Index
Master Index
New Book
mi_fparam_copy()
The
mi_fparam_copy()
function allocates an
MI_FPARAM
structure on behalf of a user-defined routine and copies an input
MI_FPARAM
structure to the allocated one field by field.
Syntax
MI_FPARAM *mi_fparam_copy(
fp_in
)
MI_FPARAM *fp_in;
fp_in
is the input
MI_FPARAM
structure to copy.
Valid in Client Application?
Valid in Server Routine?
Yes
Yes
Usage
The function is used when a user-defined routine needs to reuse an
MI_FPARAM
structure (originally allocated by the database server for a particular user-defined routine) with some modifications required by the user application.
In the database server, the
fp_usr_fparam
value in the new
MI_FPARAM
structure is set independently of its value in the input
MI_FPARAM
structure. The
fp_usr_fparam
value is
MI_TRUE
, which indicates that the new
MI_FPARAM
structure was allocated on behalf of a user-defined routine, not by the database server.
The
mi_fparam_copy()
function performs a deep copy of every value from the input
MI_FPARAM
structure to the target
MI_FPARAM
structure except the
fp_funcState
and
fp_row
values.
Return Values
On success, the
mi_fparam_copy()
function returns a handle to the new
MI_FPARAM
structure that was copied from the input
MI_FPARAM
structure.
On
failure, this function returns
NULL.
Related Topics
For additional information, see the descriptions of the following functions:
mi_fp_usr_fparam()
,
mi_fparam_allocate()
, and
mi_fparam_free()
.
DataBlade API Programmer's Manual
, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.
