EnumReferencedKeys List

SQLServer.Database.Table Object

Description

Lists the keys of other tables that are referenced by the keys of this Table. List is returned in a QueryResults object.

Visual Basic

QueryResults = Table.EnumReferencedKeys (
[[ReferencedTableName :=] idTable,]
[[IncludeAllCandidates :=] bIncludeCandidates] )

C++

HRESULT pTable->EnumReferencedKeys (
LPSQLOLEQUERYRESULTS* ppQueryResults,
SQLOLE_LPCSTR idTable = NULL,
BOOL bIncludeCandidates = NULL );

Elements

Element Type Description

QueryResults QueryResults Returned QueryResults object
idTable Identifier Table to list the keys of
bIncludeCandidates Boolean Determines if all possible candidate tables are included in the list, even those not referenced. If True, candidate tables are included. If False, candidate tables are not included.

QueryResults

ColumnName ColumnType

candidate_table SQLOLE_DTypeChar
candidate_key SQLOLE_DTypeChar
referenced SQLOLE_DTypeBit

Remarks

The returned QueryResults contains a column indicating if a key is referenced.