sqlipGetColattr
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This statement-level method is called to retrieve additional information about a column.
int sqlipGetColattr(
int iCol,
int iAttrType,
StringBuffer pColAttrVal)
Parameters for sqlip_get_colattr
| Parameter | Type | Description |
| INPUT | ||
| iCol | int | Column number. The first column starts at zero. |
| iAttrType | int | Column attribute to return information for. See Table Column Attributes for information about the column attributes. |
| OUTPUT | ||
| pColAttrVal | StringBuffer | String to return the requested column attribute value in. |
| RETURN | ||
| int | OADS_SUCCESS OADS_ERROR |
The following table describes the column attributes.
Column Attributes
| Column Attribute | Description |
| OADS_COL_ATTR_CATALOG_NAME | Return the catalog this column belongs to. If not applicable, return an empty string. |
| OADS_COL_ATTR_SCHEMA_NAME | Return the schema this column belongs to. If not applicable, return an empty string. |
| OADS_COL_ATTR_BASE_TABLE_NAME | Return the base table this column belongs to. If not applicable, return an empty string. |
| OADS_COL_ATTR_BASE_COLUMN_NAME | Return the base column name of the specified column. If not applicable, return an empty string. |
| OADS_COL_ATTR_TYPE_NAME | Return the data type name of the specified column. If not applicable, return an empty string. |
| OADS_COL_ATTR_DESC_HIDDEN | Return 1 if the column is hidden, otherwise return 0. |
| OADS_COL_ATTR_DESC_KEY | Return 1 if the column is a key column, otherwise return 0. |