DataBlade API Programmer's Manual

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

mi_lo_colinfo_by_ids()

The mi_lo_colinfo_by_ids() function sets the fields of an LO-specification structure to the column-level storage characteristics for specified row descriptor and column identifier.

Syntax

#include "milo.h"

...
mi_integer mi_lo_colinfo_by_ids(conn, row_desc, column_id, LO_spec)

		MI_CONNECTION *conn;

		MI_ROW *row_desc;

		mi_integer column_id;

		MI_LO_SPEC *LO_spec; 


conn
is a pointer to the connection descriptor that a previous call to mi_open() or mi_server_connect() established.

row_desc
is a pointer to the row descriptor that contains the column.

column_num
is the integer column identifier of the column within the row descriptor, with the first column starting at offset 0.

LO_spec
is a pointer to the LO-specification structure into which mi_lo_colinfo_by_ids() puts the storage characteristics for the specified column.







 



Valid in Client Application?

Valid in Server Routine?

No
Yes

Usage

The mi_lo_colinfo_by_ids() function sets the fields of the LO-specification structure that LO_spec references to the storage characteristics for a specified column. Identify this column with the following arguments:

The row_desc argument references the row descriptor (the MI_ROW structure) that contains the column.
The column_num argument is the offset of the column within the row descriptor that row_desc identifies.

If this specified column does not have column-level storage characteristics defined for it, the database server uses the storage characteristics that are inherited.

The mi_lo_colinfo_by_ids() function is primarily intended for use within the assign() or import support routines of an opaque data type. Within either of these support functions, the data type system guarantees that the row and the column information can be determined from the MI_FPARAM structure with the accessor functions, mi_fp_getrow() and mi_fp_getcolid(). This function also works for any user-defined routine that is named or directly used in an INSERT, UPDATE, or SELECT statement. In all other contexts, the data type system does not guarantee that the row and column information in the MI_FPARAM structure is valid.

Return Values

MI_OK
The function was successful; LO_spec points to the LO-
specification structure with the storage characteristics of the specified column.

MI_ERROR
The function was not successful.

DataBlade API Programmer's ManualChapter 12: DataBlade API Function Descriptions Home Contents Index Master Index New Book

mi_lo_colinfo_by_ids()

Syntax

Usage

Return Values MI_OK The function was successful; LO_spec points to the LO-specification structure with the storage characteristics of the specified column. MI_ERROR The function was not successful.

Related Topics

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

Return Values

MI_OK
The function was successful; LO_spec points to the LO-
specification structure with the storage characteristics of the specified column.

MI_ERROR
The function was not successful.