Share via


DataGenerationServices.GetDefaultForeignKeyGenerator Method

Returns a specific foreign key generator that is designated as the default.

Namespace:  Microsoft.Data.Schema.Tools.DataGenerator
Assembly:  Microsoft.Data.Schema.Tools (in Microsoft.Data.Schema.Tools.dll)

Syntax

'Declaration
Public Overridable Function GetDefaultForeignKeyGenerator ( _
    generators As ReadOnlyCollection(Of ExtensionHandle(Of IGenerator)) _
) As ExtensionHandle(Of IGenerator)
public virtual ExtensionHandle<IGenerator> GetDefaultForeignKeyGenerator(
    ReadOnlyCollection<ExtensionHandle<IGenerator>> generators
)
public:
virtual ExtensionHandle<IGenerator^>^ GetDefaultForeignKeyGenerator(
    ReadOnlyCollection<ExtensionHandle<IGenerator^>^>^ generators
)
abstract GetDefaultForeignKeyGenerator : 
        generators:ReadOnlyCollection<ExtensionHandle<IGenerator>> -> ExtensionHandle<IGenerator> 
override GetDefaultForeignKeyGenerator : 
        generators:ReadOnlyCollection<ExtensionHandle<IGenerator>> -> ExtensionHandle<IGenerator> 
public function GetDefaultForeignKeyGenerator(
    generators : ReadOnlyCollection<ExtensionHandle<IGenerator>>
) : ExtensionHandle<IGenerator>

Parameters

Return Value

Type: Microsoft.Data.Schema.Extensibility.ExtensionHandle<IGenerator>
An extension handle for a generator that represents the default foreign key generator.

Remarks

The SQL Server model has only one foreign key generator, so this method returns nulla null reference (Nothing in Visual Basic); your model may require more than one foreign key generator.

Provide this information through this method so that your database schema model can be represented in Visual Studio projects, where users can create and manipulate database objects that you have defined in your model.

.NET Framework Security

See Also

Reference

DataGenerationServices Class

Microsoft.Data.Schema.Tools.DataGenerator Namespace

IGenerator