DeclareParameter Class

Summary

Used to declare a parameter during package or archive creation. Can only be used with or Also see the documentation at https://technet.microsoft.com/en-us/library/dd569084(v=ws.10).aspx
Namespace
Cake.MsDeploy.Parameters
Interfaces
Base Types
graph TD Base0["BaseParameter"]-->Type click Base0 "/Cake.MsDeploy/api/Cake.MsDeploy.Parameters/BaseParameter" Base1["object"]-->Base0 Interface0["IParameter"]-.->Type click Interface0 "/Cake.MsDeploy/api/Cake.MsDeploy.Parameters/IParameter" Interface1["IMsDeployArgument"]-.->Type click Interface1 "/Cake.MsDeploy/api/Cake.MsDeploy/IMsDeployArgument" Type["DeclareParameter"] class Type type-node

Syntax

public class DeclareParameter : BaseParameter, IParameter, IMsDeployArgument

Properties

Name Value Summary
DefaultValue string
Optionally specifies a default value for a parameter
Description string
An optional user-supplied string that describes the purpose of the parameter
Kind ParameterKind?
specifies the parameter kind
Match string
Specifies an item to be matched
Name string
Name of the declared parameter
Scope string
The scope of the specified parameter kind
Tags IEnumerable<string>
Optionally sets attributes about the parameter for later reference

Methods

Name Value Summary
AppendCommandLineArgument(StringBuilder) void
Converts the object into its MSDeploy command line equivalent and Appends it to the stringbuilder
AppendCommonParameters(StringBuilder, string, ParameterKind?, string, string) void
Inherited from BaseParameter
ToCommandLineArgument() string
Converts the DeclareParameter into its commmand line argument

See Also

  • Providers.MsDeployProviderType.package
  • Providers.MsDeployProviderType.archiveDir