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_name()

The mi_lo_colinfo_by_name() function sets the fields of an LO-specification structure to the column-level storage characteristics for a specified database column.

Syntax

#include "milo.h"

...
mi_integer mi_lo_colinfo_by_name(conn, column_spec, LO_spec)

		MI_CONNECTION *conn;

		const char *column_spec;

		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.

column_spec
is a pointer to a buffer that contains the name of the database column whose column-level storage characteristics you want to use.

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







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_lo_colinfo_by_name() function sets the fields of the LO-specification structure that LO_spec references to the storage characteristics for the column_spec database column. 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 column_spec buffer must specify the column name in the following format:

database@server_name:table.column

In the preceding format, the database and server_name arguments are optional. The following column specifications are all valid:

Full column specification: emp_data@main_server:employee.resume
Column specification that omits the server_name argument: emp_data:employee.resume

mi_lo_colinfo_by_name()

employee

Column specification that omits the database and server_name arguments: employee.resume

mi_lo_colinfo_by_name()

employee

ANSI

If the column is in a database that is ANSI compliant, you can also include the owner name, as follows:

database@server_name:owner.table.column

Return Values

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

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_name()

Syntax

Usage

Return Values MI_OK The function was successful; LO_spec points to the LO-specification structure with the storage characteristics of column_spec. 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 column_spec.

MI_ERROR
The function was not successful.