The EnumReferencingKeys method returns a QueryResults object enumerating the FOREIGN KEY constraints depending on a candidate key defined on the referenced table.
object.EnumReferencingKeys( [ ReferencingTable ] , [ IncludeAll ] )
as QueryResults
| Part | Description |
|---|---|
| object | Expression that evaluates to an object in the Applies To list. |
| ReferencingTable | Optional. String naming 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. |
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 FOREIGN KEY constraint is defined. |
| candidate_key | nvarchar(129) | Name of the FOREIGN KEY constraint depending on a candidate key in the referenced table |
| 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.
HRESULT EnumReferencingKeys(
LPSQLDMOQUERYRESULTS* ppResults,
SQLDMO_LPCSTR ReferencingTableName = NULL,
BOOL IncludeAllCandidates = NULL);