InstallSettings Class

Summary

Windows service installation settings.
Assembly
Cake.Services.dll
Namespace
Cake.Services
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["InstallSettings"] class Type type-node

Syntax

public class InstallSettings

Constructors

Name Summary
InstallSettings() Initializes a new instance of the InstallSettings class.

Properties

Name Value Summary
Arguments ProcessArgumentBuilder
Sets the arguments to use during installation
Dependencies string
Specifies the names of services or groups that must start before this service starts. The names are separated by forward slashes (/).
Description string
Specifies a description for the specified service. If no string is specified, the description of the service is not modified. There is no limit to the number of characters in the service description.
DisplayName string
Specifies a friendly name that can be used by user interface programs to identify the service.
ExecutablePath FilePath
Specifies a path to the service binary file.
OutputToAppConsole bool
If the host should output to the app's console
Password string
Gets or sets the credentials to use when connecting
ServiceName string
Specifies the service name returned by the getkeyname operation.
StartMode string
Specifies the start type for the service. The default setting is start= demand.
Username string
Gets or sets the credentials to use when connecting

Extension Methods

Name Value Summary
Dump<InstallSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<InstallSettings>(InstallSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<InstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<InstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetDependencies(string) InstallSettings
Specifies the names of services or groups that must start before this service starts. The names are separated by forward slashes (/).
Requires the Cake.Services addin
SetDescription(string) InstallSettings
Specifies a description for the specified service. If no string is specified, the description of the service is not modified. There is no limit to the number of characters in the service description.
Requires the Cake.Services addin
SetDisplayName(string) InstallSettings
Specifies a friendly name that can be used by user interface programs to identify the service.
Requires the Cake.Services addin
SetExecutablePath(FilePath) InstallSettings
Specifies a path to the service binary file.
Requires the Cake.Services addin
SetServiceName(string) InstallSettings
Specifies the service name returned by the getkeyname operation.
Requires the Cake.Services addin
SetStartMode(string) InstallSettings
Specifies the start type for the service. The default setting is start= demand.
Requires the Cake.Services addin
ThrowIfNull<InstallSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<InstallSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
UsePassword(string) InstallSettings
Gets or sets the credentials to use when connecting
Requires the Cake.Services addin
UseUsername(string) InstallSettings
Gets or sets the credentials to use when connecting
Requires the Cake.Services addin
WithArguments(Action<ProcessArgumentBuilder>) InstallSettings
Sets the arguments to use during installation
Requires the Cake.Services addin