ContributorArgumentConfiguration Class
Instances of this class are created by Build and Deployment contributors during design-time to initialize arguments that are passed to them at runtime. In SSDT, these arguments must be specified using a ContributorArguments property in a .sqlproj file or a referenced .targets file. For instance to add a "RunMyContributor" argument with a value of "true", the following would be added:
<PropertyGroup> <ContributorArguments Condition="'$(Configuration)' == 'Debug''"> $(ContributorArguments);RunMyContributor=True; </ContributorArguments> </PropertyGroup>
In this case the argument is only added for Debug configuration. Using the above configuration it is possible to collect information from the MSBuild environment and pass it to the contributor. It is also possible to specify these when creating a package by using BuildPackage(String, TSqlModel, PackageMetadata, PackageOptions) and specifying PackageOptions.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration
Namespace: Microsoft.SqlServer.Dac.Deployment
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)
Syntax
'Declaration
Public NotInheritable Class ContributorArgumentConfiguration
'Usage
Dim instance As ContributorArgumentConfiguration
public sealed class ContributorArgumentConfiguration
public ref class ContributorArgumentConfiguration sealed
[<SealedAttribute>]
type ContributorArgumentConfiguration = class end
public final class ContributorArgumentConfiguration
The ContributorArgumentConfiguration type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ContributorArgumentConfiguration() | Initializes a new instance of the ContributorArgumentConfiguration class. |
|
ContributorArgumentConfiguration(String, String) | Initializes a new instance of the ContributorArgumentConfiguration class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Name | Gets or sets the name of the argument. |
|
Value | Gets or sets the value of the argument expressed as a string. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
Top
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.