Home | Previous Page | Next Page   Function Descriptions >

mi_column_name( )

The mi_column_name( ) function obtains the name of a specified column from a row descriptor.

Syntax

mi_string *mi_column_name(row_desc, column_id)
   MI_ROW_DESC *row_desc;
   mi_integer column_id;
row_desc
is a pointer to the row descriptor for the row that contains the column.
column_id
indicates the column identifier, which specifies the position of the column in the specified row descriptor. Column numbering follows C array-indexing conventions: the first column in the row descriptor is at position zero (0).
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

A row descriptor can describe the structure of a row in a table or the structure of a row type. From the row descriptor that row_desc references, the mi_column_name( ) function obtains the name of a column for either structure:

The name that mi_column_name( ) returns is a pointer to a null-terminated string.

Server Only

The mi_column_name( ) function allocates memory in the current memory duration for the string that it returns.

End of Server Only

Return Values

An mi_string pointer
is a pointer to the null-terminated column or field name.
NULL
indicates that the function was not successful.

Related Topics

See also the descriptions of mi_column_count( ), mi_column_id( ), mi_column_nullable( ), mi_column_precision( ), mi_column_scale( ), mi_column_type_id( ), mi_column_typedesc( ), mi_get_row_desc( ), and mi_get_row_desc_without_row( ).

For more information about row descriptors, see the IBM Informix: DataBlade API Programmer's Guide.

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