2. OpenAPI Function Reference : OpenAPI Functions : IIapi_getColumnInfo() Function--Return Additional Information about Columns
 
Share this page                  
IIapi_getColumnInfo() Function--Return Additional Information about Columns
The IIapi_getColumnInfo() function retrieves additional information about columns. The information for a column is available after it has been retrieved by IIapi_getColumns().
This function has the following syntax:
II_VOID IIapi_getColumnInfo( IIAPI_GETCOLINFOPARM *getColInfoParm );
 
typedef struct _ IIAPI _GETCOLINFOPARM
{
        II_PTR               gi_stmtHandle;
        II_INT2              gi_columnNumber;
        IIAPI_STATUS         gi_status;
        II_ULONG             gi_mask;
        II_UINT8             gi_lobLength;
} IIAPI_GETCOLINFOPARM;
This function has the following parameters:
gi_stmtHandle
Type: input
Specifies the statement handle identifying the query.
gi_columnNumber
Type: input
Specifies the number of the column for which information is to be returned. This parameter must contain a non-zero positive integer that cannot exceed the total number of columns in a row.
gi_status
Type: immediate output
Returns IIAPI_ST_SUCCESS if the column information is successfully returned. Returns IIAPI_ST_FAILURE if gi_columnNumber is less than 1 or greater than the number of columns in rows returned by the statement.
gi_mask
Type: immediate output
Specifies the mask indicating the available column information. This parameter is 0 or a mask of the following values:
IIAPI_GI_LOB_LENGTH
gi_lobLength
Type: immediate output
Specifies the length of a LOB column as indicated by the DBMS. The length is available once the first segment of the LOB has been retrieved. Also provides the length of a LOB value associated with a LOB locator. This parameter is valid only if the IIAPI_GI_LOB_LENGTH mask is set in gq_mask; otherwise, this parameter should be ignored.