The mi_qual_needoutput() accessor function

The mi_qual_needoutput() function determines whether the access method must set the value for an OUT argument in a UDR.

Syntax

mi_boolean mi_qual_needoutput(MI_AM_QUAL_DESC *qualDesc,
   mi_integer n);

qualDesc: Points to the qualification descriptor.
n: Is always set to 0 to indicate the first and only argument that needs a value.

Usage

If a UDR declaration includes an out parameter, the function call in the WHERE clause includes a corresponding placeholder, called a statement-local variable (SLV). If the mi_qual_needoutput() function detects the presence of an SLV, the access method calls the mi_qual_setoutput() function to set a constant value for that SLV.

Return values

MI_TRUE: Indicates that the strategy function involves an SLV argument.
MI_FALSE: Indicates that the strategy function does not specify an SLV argument.