Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_routine_get_by_typeid() function looks up a registered user-defined routine by a routine signature that it builds from a list of arguments and returns its function descriptor.

MI_FUNC_DESC *mi_routine_get_by_typeid(conn, udr_type, udr_name, owner,

arg_count, arg_types)

MI_CONNECTION *conn;

MI_UDR_TYPE udr_type;

char *udr_name;

char *owner;

mi_integer arg_count;

MI_TYPEID *arg_types;

conn	is a pointer to the connection descriptor that a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect() has established.
udr_type	is an MI_UDR_TYPE constant that indicates whether the user-defined routine is a function or a procedure:
	MI_FUNC	The user-defined routine is a function.
	MI_PROC	The user-defined routine is a procedure.
udr_name	is the name of the user-defined routine.
owner	is the owner of the routine. For more information on how to specify an owner name, see the Usage section.
arg_count	is the integer number of arguments that the user-defined routine takes.
arg_types	is an array of pointers to type identifier, one type identifier for each of the udr_name routine arguments.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

The mi_routine_get_by_typeid() function creates a function descriptor for the UDR that the routine signature specifies. The function builds the routine signature from the udr_type, udr_name, owner, arg_count, and arg_types arguments. The mi_routine_get_by_typeid() function is one of the functions of the Fastpath interface. It is a constructor function for the function descriptor and

The mi_routine_get_by_typeid() function performs the following tasks:

1. Looks for a user-defined routine that matches the routine signature in the sysprocedures system catalog table.
2. Allocates a function descriptor for the routine and saves the routine sequence in this descriptor.
3. Allocates an MI_FPARAM structure for the routine and saves the argument and return-value information in this structure.
4. Returns a pointer to the function descriptor that it allocated for the user-defined routine.

The mi_routine_get_by_typeid() function allocates a new function descriptor in the PER_COMMAND memory duration.

When the UDR is defined in a database that is not ANSI-compliant, mi_routine_get_by_typeid() looks for UDRs owned only by owner. If you specify a NULL-valued pointer as an owner, mi_routine_get_by_typeid() looks for UDRs owned by anyone. The following call to mi_routine_get_by_typeid() looks for the a_proc() user-defined procedure in a database that is not ANSI compliant:

MI_TYPEID *arg_types[2];

MI_FUNC_DESC *func_desc;

MI_CONNECTION *conn;


arg_types[0] = mi_typestring_to_id(conn, "integer");
arg_types[1] = mi_typestring_to_id(conn, "datetime");
func_desc = mi_routine_get_by_typeid(conn, MI_PROC, 
	"a_proc", NULL, 2, arg_types);


When the UDR is defined in an ANSI-complaint database, owner is part of its routine signature. You can specify a particular owner name to obtain UDRs of a particular owner. If you specify a NULL-valued pointer as an owner, mi_routine_get_by_typeid() assumes the current user account as the owner name. If no UDRs exist for the current user, mi_routine_get_by_typeid() looks for UDRs with user informix as the owner name.

If a_proc() was defined in an ANSI-compliant database, the following call to mi_routine_get_by_typeid() looks up the a_proc() user-defined procedure owned by user dexter:

func_desc = mi_routine_get_by_typeid(conn, 0, MI_PROC,

	"a_udr", "dexter", 2, arg_types);

Other internal errors raise an exception.

See the descriptions of the following functions: mi_fparam_get(), mi_routine_get(), mi_routine_exec(), mi_routine_end(), and mi_td_cast_get().

For more information, see Calling UDRs with the Fastpath Interface.