EnumCandidateKeys 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 EnumCandidateKeys method returns a QueryResults object that enumerates the user tables of a Microsoft SQL Server database and the constraints on those tables that could define primary keys.

Syntax

object.EnumCandidateKeys( )as QueryResults

Parts

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

Prototype (C/C++)

HRESULT EnumCandidateKeys(
LPSQLDMOQUERYRESULTS* ppResults);

Returns

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

Column

Data type

Description

candidate_table

nvarchar(262)

SQL Server table name.

candidate_key

nvarchar(129)

Name of an existing UNIQUE or PRIMARY KEY constraint.

Applies To: