The mi_func_commutator() function

The mi_func_commutator() function obtains the name of a commutator function for a user-defined function.

Syntax

char *mi_func_commutator(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_commutator() function obtains the name of the commutator function for the user-defined function associated with the funcdesc_ptr function descriptor. When you register a user-defined function, you can use the COMMUTATOR routine modifier of the CREATE FUNCTION statement to associate a commutator function with the user-defined function. To be a commutator function, a user-defined function must have either of the following similarities to the registered user-defined function:
  • The commutator function takes the same arguments as the registered user-defined function but in opposite order.
  • The commutator function returns the same result as the registered user-defined function.

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

Return values

A char pointer
A pointer to the name of the commutator function for the user-defined function that the funcdesc_ptr function descriptor identifies.
NULL
The function was not successful.