OASQLIP_specialcolumns
- Last Updated: May 12, 2026
- 2 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
OASQLIP_specialcolumns
This function makes a result set available with special columns that match the criteria specified by the input arguments. The result set must match the OA_COLUMNS table definition.
int OASQLIP_specialcolumns(
SQLIP_HSTMT sqlip_hstmt,
OADS_SMALLINT iColType,
OAWCHAR * sQual,
OADS_SMALLINT iQualLen,
OAWCHAR * sOwner,
OADS_SMALLINT iOwnerLen,
OAWCHAR * sName,
OADS_SMALLINT iNameLen,
OADS_SMALLINT iScope,
OADS_SMALLINT iNullable)
Parameters for OASQLIP_specialcolumns
| Parameter | Type | Description |
| INPUT | ||
| sqlip_hstmt | SQLIP_HSTMT | Statement handle. |
| iColType | OADS_SMALLINT | Indicates the type of the column to be returned:SQL_BEST_ROWID: Return the optimal column or set of columns that, by retrieving values from the column or columns, allows any row in the specified table to be uniquely identified. A column can be either a pseudo-column specifically designed for this purpose (as in Oracle ROWID) or the column or columns of any unique index for the table. SQL_ROWVER: Return the column or columns in the specified table, if any, that are automatically updated by the data source when any value in the row is updated by any transaction (as in SQLBase ROWID or Sybase TIMESTAMP). |
| sQual | OAWCHAR * | Qualifier name used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| iQualLen | OADS_SMALLINT | Length of the qualifier name in characters. |
| sOwner | OAWCHAR * | Owner name used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| iOwnerLen | OADS_SMALLINT | Length of the owner name in characters. |
| sName | OAWCHAR * | Table name used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| iNameLen | OADS_SMALLINT | Length of the table name in characters. |
| iScope | OADS_SMALLINT | Minimum required scope of the rowid. The returned rowid may be of greater scope. Value will be one of the following: SQL_SCOPE_CURROW: The rowid is guaranteed to be valid only while positioned on that row. A later reselect using rowid may not return a row if the row was updated or deleted by another transaction. SQL_SCOPE_TRANSACTION: The rowid is guaranteed to be valid for the duration of the current transaction. SQL_SCOPE_SESSION: The rowid is guaranteed to be valid for the duration of the session (across transaction boundaries). |
| iNullable | OADS_SMALLINT | TRUE means column should allow NULL values. FALSE means columns should not allow NULL values. |
| RETURN | ||
| int | OADS_SUCCESS OADS_ERROR |