Table.EnumForeignKeys Method

Enumerates a list of primary keys in which the table is referenced as a foreign key.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Function EnumForeignKeys As DataTable
'Usage
Dim instance As Table 
Dim returnValue As DataTable 

returnValue = instance.EnumForeignKeys()

public DataTable EnumForeignKeys()

public:
DataTable^ EnumForeignKeys()

member EnumForeignKeys : unit -> DataTable

public function EnumForeignKeys() : DataTable

Return Value

Type: System.Data.DataTable
A DataTable system object value that contains a list of information about where this table is referenced as a foreign key. The table describes the different columns of the returned DataTable.

Examples

The following code example demonstrates how to enumerate a list of the primary keys that reference the table as a foreign key.

C#

Server srv = new Server("(local)");
Database db = srv.Databases["AdventureWorks2012"];

foreach (Table tb in db.Tables)
{
   tb.EnumForeignKeys();
}

Powershell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")

foreach ($tb in $db.Tables)
{
   $tb.EnumForeignKeys()
}

See Also

Reference

Table Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Tables

CREATE TABLE (Transact-SQL)