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_func_isvariant() functionThe mi_func_isvariant() function determines whether a user-defined function is variant.

The mi_func_isvariant() function

The mi_func_isvariant() function determines whether a user-defined function is variant.

Syntax

mi_integer mi_func_isvariant(funcdesc_ptr)
   MI_FUNC_DESC *funcdesc_ptr;

funcdesc_ptr: A pointer to a function descriptor for a user-defined function.


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

Usage

The mi_func_isvariant() function determines whether the user-defined function associated with the funcdesc_ptr function descriptor is variant or nonvariant. A user-defined function is variant if it behaves in either of the following ways:

Returns different results when it is invoked with the same arguments
Modifies a database or variable state

You can register a user-defined function as variant with the VARIANT routine modifier. If you do not specify the VARIANT or NOT VARIANT routine modifier with the CREATE FUNCTION statement, the user-defined function is variant.

The mi_func_isvariant() function is one of the functions of the Fastpath interface.

Return values

1: The UDR that the funcdesc_ptr function descriptor identifies is variant.
2: The UDR that the funcdesc_ptr function descriptor identifies is not variant.
MI_ERROR: The function was not successful.