Share via

DGenCompatibilityAttribute Class

  • Article

Specifies that this data generator assembly should replace a specific earlier version of an assembly when a data generation plan is loaded.

Namespace:  Microsoft.VisualStudio.TeamSystem.Data.DataGenerator
Assembly:  Microsoft.VisualStudio.TeamSystem.Data (in Microsoft.VisualStudio.TeamSystem.Data.dll)

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple := True, Inherited := False)> _
Public NotInheritable Class DGenCompatibilityAttribute _
    Inherits Attribute
'Usage
Dim instance As DGenCompatibilityAttribute

[CLSCompliantAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple = true, Inherited = false)]
public sealed class DGenCompatibilityAttribute : Attribute

[CLSCompliantAttribute(true)]
[AttributeUsageAttribute(AttributeTargets::Assembly, AllowMultiple = true, Inherited = false)]
public ref class DGenCompatibilityAttribute sealed : public Attribute

public final class DGenCompatibilityAttribute extends Attribute

Remarks

If you update a data generator, you can use this attribute to specify that data generation plans can use the updated assembly for that generator. By using this attribute, you can avoid having to update any plans that refer to the older version of the assembly.

Examples

You might have a data generator assembly that is named CustomGenerators, that has a version number of 1.0.0.0, and to which one or more data generation plans refer. In this situation, you could apply this attribute to the 2.0.0.0 version of the CustomGenerators assembly as follows:

[assembly: DGenCompatibility(@"CustomGenerators, Version=1.0.0.0, Culture=neutral, PublicKeyToken=ffffffffffffffff", "2.0.0.0")]

When a user who has 2.0.0.0 assembly tries to load a data generation plan that refers to a data generator in the 1.0.0.0 assembly, the same generator is loaded from the 2.0.0.0 assembly instead.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.TeamSystem.Data.DataGenerator.DGenCompatibilityAttribute

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

DGenCompatibilityAttribute Members

Microsoft.VisualStudio.TeamSystem.Data.DataGenerator Namespace