INFORMIX
DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home Contents Index Master Index New Book

mi_get_row_desc()

The mi_get_row_desc() function gets a pointer to the row descriptor for the specified row.

Syntax

Usage

A row descriptor is an MI_ROW_DESC structure that describes the structure of a row of data.

Several functions that return information about columns require an MI_ROW_DESC structure as an input parameter.

This function is useful for processing returned row data, especially when not all the rows returned by a query have the same size and structure. For an example of a case requiring mi_get_row_desc(), see "Example: get_data()".

The row descriptor returned by mi_get_row_desc() is valid while the row it came from is valid. For information about row validity, see the description of the mi_next_row() function.

Return Values

On success, returns a pointer to the row descriptor for the row; on failure, returns NULL.

Related Topics

For additional information, see the description of the mi_get_row_desc_without_row() function.




DataBlade API Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.