The mi_qual_param() accessor function

Syntax

MI_AM_PARAM_DESC* mi_qual_param(MI_AM_QUAL_DESC *qualDesc,
   mi_integer n);

qualDesc

Points to the qualification descriptor.

n

Identifies which parameter to retrieve.

Set n to 0 to retrieve the first parameter descriptor in the array of parameter descriptors. Set n to 1 to retrieve the second parameter descriptor in the array. Increment n by 1 to retrieve each subsequent parameter.

Usage

To determine the number of parameters in an expression and thus the number of iterations through mi_qual_param(), first call the mi_qual_nparams() accessor function. If mi_qual_nparams() returns 1, the access method does not call mi_qual_param() because the access method already knows the address of the qualification descriptor. For a simple qualification, mi_qual_param() points to the same qualification descriptor as mi_scan_quals().

If mi_qual_nparams() returns a value greater than 1, the qualification descriptor combines nested qualifications in a complex expression. The access method can loop through mi_qual_param() to process each parameter.

Return values

The pointer that this function returns provides the beginning address of the specified parameter.