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_type_name() functionThe mi_parameter_type_name() function returns the data type name of the column that is associated with a specified input parameter in a prepared statement.

The mi_parameter_type_name() function

The mi_parameter_type_name() function returns the data type name of the column that is associated with a specified input parameter in a prepared statement.

Syntax

mi_string *mi_parameter_type_name(stmt_desc, param_id)
   MI_STATEMENT *stmt_desc;
   mi_integer param_id;

stmt_desc: A pointer to the statement descriptor for the prepared statement that contains the input parameter.
param_id: The parameter identifier of the column, which specifies the position of the input parameter in the specified statement descriptor. Input-parameter numbering follows C programming conventions: the first parameter in the statement is at position zero.


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

Usage

The mi_parameter_type_name() function obtains the data type name of the column that is associated with param_id from the statement descriptor that stmt_desc references. This function is an accessor function for a statement descriptor, which describes a prepared statement. The statement descriptor stores information about the type names of input-parameter columns in the zero-based parameter-type name array. To obtain information about the nth input parameter, use a param_id value of n-1.

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_type_name() raises an exception.

Return values

An mi_string pointer: The name of the data type of the column that is associated with the specified input parameter.
NULL: The function was not successful.