informix
Informix DataBlade API Programmer's Manual
DataBlade API Function Descriptions

mi_funcarg_get_routine_id()

The mi_funcarg_get_routine_id() returns the routine identifier for the expensive UDR of a cost or selectivity function.

Syntax

Usage

The mi_funcarg_get_routine_id() function returns the routine identifier from the MI_FUNCARG structure that funcarg_ptr references. The MI_FUNCARG structure describes an argument of an expensive UDR to its cost or selectivity function.

Tip: The DataBlade API provides the mi_funcid data type to hold routine identifiers. The mi_funcid data type has the same structure as the mi_integer data type. However, this DataBlade API function still assumes that routine identifiers are of type mi_integer.

Use the mi_funcarg_get_routine_id() function in a cost or selectivity function to obtain the routine identifier for the expensive UDR.

Return Values

>= 0 is the routine identifier for the expensive UDR.
MI_ERROR indicates that the function was not successful.

Related Topics

See the descriptions of the following functions: mi_funcarg_get_argtype(), mi_funcarg_get_colno(), mi_funcarg_get_constant(), mi_funcarg_get_datalen(), mi_funcarg_get_datatype(), mi_funcarg_get_distrib(), mi_funcarg_get_routine_name(), mi_funcarg_get_tabid(), and mi_funcarg_isnull().

For more information, see Creating Selectivity and Cost Functions.


Informix DataBlade API Programmer's Manual, Version 9.2
Copyright © 1999, Informix Software, Inc. All rights reserved