Home | Previous Page | Next Page   Descriptor Function Reference > Accessor Functions >

mi_qual_needoutput()

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.

For examples of OUT parameters and SLVs, refer to Runtime Values as Arguments.

Return Values

MI_TRUE indicates that the qualification function involves an SLV argument. MI_FALSE indicates that the qualification function does not specify an SLV argument.

Related Topics

See the description of accessor function mi_qual_setoutput().

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]