The mi_tab_rowdesc() accessor function

The mi_tab_rowdesc() function retrieves the row descriptor, which describes the columns that belong to the index that the table descriptor identifies.

Syntax

MI_ROW_DESC* mi_tab_rowdesc(MI_AM_TABLE_DESC *tableDesc)
tableDesc
Points to the index descriptor.

Usage

To access information in the row descriptor, pass the pointer in this column to the DataBlade® API row-descriptor accessor functions. A row descriptor describes the columns that make up the index.

The order of the columns in the row descriptor corresponds to the order of the columns in the CREATE INDEX statement. Another accessor function, such as mi_scan_projs(), can obtain information about a specific column by passing the position of the column in the row descriptor.

Return values

The pointer enables the access method to locate the row descriptor, which describes the columns in this table.

Related topics

See the Informix® DataBlade API Programmer's Guide for the descriptions of:
  • DataBlade API row-descriptor accessor functions mi_column_bound(), mi_column_count(), mi_column_id(), mi_column_name(), mi_column_nullable(), mi_column_scale(), mi_column_type_id(), and mi_column_typedesc()
  • The row descriptor (MI_ROW_DESC data structure)