ReferencedKey Property

SQL-DMO

SQL-DMO

ReferencedKey Property

The ReferencedKey property returns the name of the PRIMARY KEY or UNIQUE key constraint implementing the primary key referenced by a foreign key.

Applies To
Key Object
Syntax

object.ReferencedKey

Parts

object

Expression that evaluates to an object in the Applies To list

Data Type

String

Modifiable

Read-only

Prototype (C/C++)

HRESULT GetReferencedKey(SQLDMO_LPBSTR pRetVal);

Note  SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

The ReferencedKey property returns a value for Key objects referencing foreign key definitions only. When the Type property of the Key object is SQLDMOKey_Foreign, the Key object references a foreign key definition.