Home | Previous Page | Next Page   Function Descriptions >

mi_func_isvariant( )

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
is 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:

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
indicates that the UDR that the funcdesc_ptr function descriptor identifies is variant.
2
indicates that the UDR that the funcdesc_ptr function descriptor identifies is not variant.
MI_ERROR
indicates that the function was not successful.

Related Topics

See also the descriptions of mi_cast_get( ), mi_fparam_get( ), mi_func_commutator( ), mi_func_handlesnulls( ), mi_func_negator( ), mi_routine_get( ), mi_routine_get_by_typeid( ), mi_routine_id_get( ), and mi_td_cast_get( ).

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]