通过

EnumReferencingKeys Method

  • 项目

后续版本的 Microsoft SQL Server 将删除该功能。请避免在新的开发工作中使用该功能，并着手修改当前还在使用该功能的应用程序。

The EnumReferencingKeys method returns a QueryResults object that enumerates the FOREIGN KEY constraints depending on a candidate key defined on the referenced table.

语法

object
.EnumReferencingKeys( [ ReferencingTable ] , [ IncludeAll ] )as QueryResults

Parts

  • object
    Expression that evaluates to an object in the Applies To list.
  • ReferencingTable
    Optional. String that names an existing Microsoft SQL Server table. Restricts result set membership to list only FOREIGN KEY constraints defined on the specified table.
  • IncludeAll
    TRUE or FALSE.

Prototype (C/C++)

HRESULT EnumReferencingKeys(
LPSQLDMOQUERYRESULTS* ppResults,
SQLDMO_LPCSTR ReferencingTableName = NULL,
BOOL IncludeAllCandidates = NULL);

Returns

A QueryResults object that contains one result set defined by these columns.

Column Data type Description

candidate_key

nvarchar(129)

Name of the FOREIGN KEY constraint depending on a candidate key in the referenced table.

candidate_table

nvarchar(262)

Name of a table on which a FOREIGN KEY constraint is defined.

referenced

bit

When 1, the FOREIGN KEY constraint listed in the result set depends on the table referenced by the Table object used.

备注

When IncludeAll is TRUE, the result set enumerates all user-defined tables in the database. The candidate_key column is NULL for those tables on which a FOREIGN KEY constraint is not defined. The value of the referenced column in the result set determines FOREIGN KEY constraint dependency.

When IncludeAll is FALSE (default), the result set enumerates only those FOREIGN KEY constraints depending on the referenced table.

Applies To:

Table Object