OASQLIP_foreignkeys
- Last Updated: May 12, 2026
- 2 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This function makes a result set available with foreign keys that match the criteria specified by the input arguments. The result set must match the OA_FKEYS table definition.
int OASQLIP_foreignkeys(
SQLIP_HSTMT sqlip_hstmt,
OAWCHAR * sPKQual,
OADS_SMALLINT PKQualLen,
OAWCHAR * sPKOwner,
OADS_SMALLINT PKOwnerLen,
OAWCHAR * sPKName,
OADS_SMALLINT PKNameLen,
OAWCHAR * sFKQual,
OADS_SMALLINT FKQualLen,
OAWCHAR * sFKOwner,
OADS_SMALLINT FKOwnerLen,
OAWCHAR * FKName,
OADS_SMALLINT FKNameLen)
Parameters for OASQLIP_foreignkeys
| Parameter | Type | Description |
| INPUT | ||
| sqlip_hstmt | SQLIP_HSTMT | Statement handle. |
| sPKQual | OAWCHAR * | Qualifier name of the primary key table used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| PKQualLen | OADS_SMALLINT | Length of the primary key table qualifier in characters. |
| sPKOwner | OAWCHAR * | Owner name of the primary key table used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| PKOwnerLen | OADS_SMALLINT | Length of the owner name of the primary key table in characters. |
| sPKName | OAWCHAR * | Primary key table name used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| PKNameLen | OADS_SMALLINT | Length of the primary key table name in characters. |
| sFKQual | OAWCHAR * | Qualifier name of the foreign key table used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| FKQualLen | OADS_SMALLINT | Length of the qualifier name of the foreign key table in characters. |
| sFKOwner | OAWCHAR * | Owner name of the foreign key table used to narrow down the search. When set to NULL, the parameter is ignored for search. |
| FKOwnerLen | OADS_SMALLINT | Length of the owner name of the foreign key table in characters. |
| sFKName | OAWCHAR * | Foreign key table name used to narrow the search. When set to NULL, the parameter is ignored for search. |
| FKNameLen | OADS_SMALLINT | Length of the foreign key table name in characters. |
| RETURN | ||
| int | OADS_SUCCESS OADS_ERROR |