mi_integer mi_funcarg_get_colno(funcarg_ptr)
   MI_FUNCARG *funcarg_ptr;

funcarg_ptr

is a pointer to the MI_FUNCARG structure that describes the companion-UDR argument.

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

The mi_funcarg_get_colno( ) function returns the column number of the argument from the MI_FUNCARG structure that funcarg_ptr references. The MI_FUNCARG structure describes an argument of a companion UDR to its cost or selectivity function. Use the mi_funcarg_get_colno( ) function only for companion-UDR arguments that are column values; that is, only arguments for which the mi_funcarg_get_argtype( ) function returns the MI_FUNCARG_COLUMN value. The column number is the value from the colid column of the syscolumns system catalog table.

Use the mi_funcarg_get_colno( ) function in a cost or selectivity function to obtain the column number for the column with which an argument passed into the companion UDR is associated.

>= 0

is the column number for the column associated with the companion-UDR argument.

MI_ERROR

indicates that the function was not successful.

See also the descriptions of mi_funcarg_get_argtype( ), mi_funcarg_get_datalen( ), mi_funcarg_get_datatype( ), mi_funcarg_get_distrib( ), mi_funcarg_get_routine_id( ), mi_funcarg_get_routine_name( ), and mi_funcarg_get_tabid( ).