The mi_tab_amparam() accessor function

The mi_tab_amparam() function retrieves any user-defined configuration values for the index.

Syntax

mi_string* mi_tab_amparam(MI_AM_TABLE_DESC *tableDesc);
tableDesc
Points to the index descriptor.

Usage

If the access method supports configuration keywords, the USING access-method clause of the CREATE INDEX statement can specify values for those keywords. A user or application can apply values to adjust the way in which the access method behaves.

To support multiple indexes on the same key column or composite of columns, use the configuration keywords as the example in Enable alternative indexes demonstrates.

To ensure that a CREATE INDEX statement does not duplicate the definition of another index, use the functions mi_tab_param_exist() and mi_tab_nparam_exist().

Return values

The pointer accesses a string that contains user-specified keywords and values. A NULL-valued pointer indicates that the CREATE INDEX statement specified no configuration keywords.