Skip to content

SQLForeignKeys 函数

功能

获取某表与外键相关的信息。

函数原型

c
SQLRETURN SQLForeignKeys(
      SQLHSTMT 		StatementHandle,
      SQLCHAR * 	PKCatalogName,
      SQLSMALLINT 	NameLength1,
      SQLCHAR * 	PKSchemaName,
      SQLSMALLINT 	NameLength2,
      SQLCHAR * 	PKTableName,
      SQLSMALLINT 	NameLength3,
      SQLCHAR * 	FKCatalogName,
      SQLSMALLINT 	NameLength4,
      SQLCHAR * 	FKSchemaName,
      SQLSMALLINT 	NameLength5,
      SQLCHAR * 	FKTableName,
      SQLSMALLINT 	NameLength6

参数解释

  • StatementHandle:语句句柄。
  • PKCatalogName:外键所引用的主键列所在表的数据库名。
  • NameLength1:以字节为单位描述参数PKCatalogName字符串的长度。
  • PKSchemaName:外键所引用的主键列所在表的模式名。
  • NameLength2 :以字节为单位描述参数PKSchemaName字符串的长度。
  • PKTableName:外键所引用的主键列所在表的表名。
  • NameLength3:以字节为单位描述参数PKTableName字符串的长度。
  • FKCatalogName:外键列所在表的数据库名。
  • NameLength4:以字节为单位描述参数FKCatalogName字符串的长度。
  • FKSchemaName:外键列所在表的模式名。
  • NameLength5:以字节为单位描述参数FKSchemaName字符串的长度。
  • FKTableName:外键列所在表的表名。
  • NameLength6:以字节为单位描述参数FKTableName字符串的长度。

返回值

成功时返回SQL_SUCCESS,失败时返回SQL_ERROR。