EnumReferencingTables Method
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The EnumReferencingTables method returns a QueryResults object that enumerates user-defined tables on which a FOREIGN KEY constraint is defined.
Syntax
object
.EnumReferencingTables( [ IncludeAll ] ) as QueryResults
Parts
- object
Expression that evaluates to an object in the Applies To list.
- IncludeAll
TRUE or FALSE.
Prototype (C/C++)
HRESULT EnumReferencingTables(
LPSQLDMOQUERYRESULTS* ppResults,
BOOL IncludeAllCandidates = NULL);
Returns
A QueryResults object that contains one result set defined by these columns.
| Column | Data type | Description |
|---|---|---|
candidate_key |
nvarchar(129) |
Not applicable. Contains the string N/A. |
candidate_table |
nvarchar(262) |
Name of a table on which a PRIMARY KEY or UNIQUE constraint is defined. |
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 that contain FOREIGN KEY constraints that depend on the referenced table.