EnumReferencingTables Method (SQL-DMO)

The EnumReferencingTables method returns a QueryResults object enumerating user-defined tables on which a FOREIGN KEY constraint is defined.

Applies To

Table Object

Syntax

object.EnumReferencingTables( [ IncludeAll ] ) as QueryResults

Part Description
object Expression that evaluates to an object in the Applies To list
IncludeAll True or False

Returns

A QueryResults object containing one result set defined by these columns.

Column Data type Description
candidate_table nvarchar(262) Name of a table on which a PRIMARY KEY or UNIQUE constraint is defined.
candidate_key nvarchar(129) Not applicable. Contains the string N/A.
referenced bit When 1, the table referenced by the Table object used depends on the listed in the result set.

Remarks

When IncludeAll is True, the result set enumerates all tables on which FOREIGN KEY constraints are defined. The value of the result set column referenced determines FOREIGN KEY dependency on the referenced table.

When IncludeAll is False (default), the result set enumerates only those tables containing FOREIGN KEY constraints that depend on the referenced table.

Prototype (C/C++)

HRESULT EnumReferencingTables(
LPSQLDMOQUERYRESULTS* ppResults,
BOOL IncludeAllCandidates = NULL);

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.