Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_parameter_count() functionThe mi_parameter_count() function returns the number of input parameters in a prepared statement.

The mi_parameter_count() function

The mi_parameter_count() function returns the number of input parameters in a prepared statement.

Syntax

mi_integer mi_parameter_count(stmt_desc)
   MI_STATEMENT *stmt_desc;

stmt_desc: A pointer to the statement descriptor for a prepared statement.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_parameter_count() function obtains the number of input parameters in the statement descriptor that stmt_desc references. A statement descriptor describes a prepared statement. You can use the mi_parameter_count() function with the DataBlade® API functions that obtain information about each input parameter of the prepared statement (such as mi_parameter_type_id() and mi_parameter_nullable()).

Parameter information is available only for the INSERT and UPDATE statements. Support for the UPDATE statement includes the following forms of UPDATE:

UPDATE with or without a WHERE clause
UPDATE WHERE CURRENT OF

If you attempt to request parameter information for other SQL statements, mi_parameter_count() raises an exception.

Return values

>=0: The number of input parameters contained in the text of the prepared statement.
MI_ERROR: The function was not successful.