Partager via


EnumReferencedKeys Method

Cette fonctionnalité sera supprimée dans une prochaine version de Microsoft SQL Server. Évitez d'utiliser cette fonctionnalité dans de nouveaux travaux de développement et prévoyez de modifier les applications qui utilisent actuellement cette fonctionnalité.

The EnumReferencedKeys method returns a QueryResults object that enumerates the PRIMARY KEY and UNIQUE constraints.

Syntaxe

object.EnumReferencedKeys( [ ReferencedTable ] , [ IncludeAll ] )as QueryResults

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

  • ReferencedTable
    Optional. String that names an existing Microsoft SQL Server table. Restricts result set membership to list only references to objects defined on the specified table.

  • IncludeAll
    TRUE or FALSE.

Prototype (C/C++)

HRESULT EnumReferencedKeys(
LPSQLDMOQUERYRESULTS* ppResults,
SQLDMO_LPCSTR ReferencedTableName = 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 a PRIMARY KEY or UNIQUE constraint.

candidate_table

nvarchar(262)

Name of a table on which a PRIMARY KEY or UNIQUE constraint is defined.

referenced

bit

When 1, the table depends on the PRIMARY KEY or UNIQUE constraint listed in the result set.

Notes

When IncludeAll is TRUE, the result set enumerates all PRIMARY KEY and UNIQUE constraints defined in the database. The value of the result set column referenced determines table object dependency on the listed PRIMARY KEY or UNIQUE constraint.

When IncludeAll is FALSE (default), the result set enumerates only those PRIMARY KEY or UNIQUE constraints on which the table depends.

Applies To: