The ifx_lo_col_info() function

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

Syntax

mint ifx_lo_col_info(column_name, LO_spec)
   char *column_name;
   ifx_lo_create_spec_t *LO_spec;

column_name: A pointer to a buffer that contains the name of the database column whose column-level storage characteristics you want to use.
LO_spec: A pointer to the LO-specification structure in which to store the column-level storage characteristics for column_name. For more information about the LO-specification structure, see The LO-specification structure.

Usage

The ifx_lo_col_info() function sets the fields of the LO-specification structure to which LO_spec points, to the storage characteristics for the column_name 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. For more information about the inheritance hierarchy, see Obtain storage characteristics.

The column_name buffer must specify the column name in the following format:

database@server_name:table.column

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

Important: You must call the ifx_lo_def_create_spec() function before you call ifx_lo_col_info().

Return codes

0: The function was successful.
<0: The function was not successful and the return value indicates the cause of the failure.