SetParameter Class

Summary

Enables you to specify, at synchronization time, a value for parameter that you declared by using DeclareParameter Also see the documentation at https://technet.microsoft.com/en-us/library/dd569084(v=ws.10).aspx
Assembly
Cake.MsDeploy.dll
Namespace
Cake.MsDeploy.Parameters
Interfaces
Base Types
graph BT Type-->Base0["BaseParameter"] click Base0 "/api/Cake.MsDeploy.Parameters/BaseParameter" Base0-->Base1["Object"] Type-.->Interface0["IParameter"] click Interface0 "/api/Cake.MsDeploy.Parameters/IParameter" Type-.->Interface1["IMsDeployArgument"] click Interface1 "/api/Cake.MsDeploy/IMsDeployArgument" Type["SetParameter"] class Type type-node

Syntax

public class SetParameter : BaseParameter, IParameter, IMsDeployArgument

Constructors

Name Summary
SetParameter()

Properties

Name Value Summary
Description string
An optional user-supplied string that describes the purpose of the parameter
Kind Nullable<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
Value string
Specifies the value for a parameter

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, Nullable<ParameterKind>, string, string) void
Inherited from BaseParameter
ToCommandLineArgument() string
Converts the SetParameter into its commmand line argument

Extension Methods

Name Value Summary
Dump<SetParameter>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SetParameter>(SetParameter[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SetParameter>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<SetParameter>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<SetParameter>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<SetParameter>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin