4D Doc Center : ODBC_SQLForeignKeys

Home

4D v14.1

ODBC_SQLForeignKeys


ODBC_SQLForeignKeys ( stmtID ; pkCatalogName ; pkSchemaName ; pkTableName ; fkCatalogName ; fkSchemaName ; fkTableName ) -> Function result

Parameter	Type	Description
stmtID	Longint	Statement ID
pkCatalogName	String	Primary key table catalog name
pkSchemaName	String	Primary key table schema name
pkTableName	String	Primary key table name
fkCatalogName	String	Foreign key table catalog name
fkSchemaName	String	Foreign key table schema name
fkTableName	String	Foreign key table name
Function result	Longint	Returns the result of the MS ODBC API function SQLForeignKeys

Description

The ODBC_SQLForeignKeys command returns a list of foreign keys in the specified table or a list of foreign keys in other tables that refer to the primary key in the specified table.

stmtID is a valid statement ID returned by ODBC_SQLAllocStmt.

pkCatalogName is the primary key catalog table name.

pkSchemaName is the primary key schema name.

pkTableName is the primary key table name.

fkCatalogName is the foreign key table catalog name.

fkSchemaName is the foreign key table schema name.

fkTableName is the foreign key table name.

For more information, please see the SQLForeignKeys function in the MS ODBC API Reference at http://msdn.microsoft.com/en-us/library/ms709315(VS.85).aspx.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.