ProcessSettings Class

Summary

Specifies a set of values that are used to start a process.
Namespace
Cake.Core.IO
Base Types
  • object
graph TD Base0["object"]-->Type Type["ProcessSettings"] class Type type-node

Syntax

public sealed class ProcessSettings

Properties

Name Value Summary
Arguments ProcessArgumentBuilder
Gets or sets the set of command-line arguments to use when starting the application.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
RedirectStandardError bool
Gets or sets a value indicating whether the error output of an application is written to the standard error stream.
RedirectStandardOutput bool
Gets or sets a value indicating whether the output of an application is written to the standard output stream.
Silent bool
Gets or sets a value indicating whether process output will be suppressed.
Timeout int?
Gets or sets optional timeout, in milliseconds, to wait for the associated process to exit. The maximum is the largest possible value of a 32-bit integer, which represents infinity to the operating system.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the process to be started.

Extension Methods

Name Value Summary
Dump<ProcessSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ProcessSettings>(ProcessSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ProcessSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<ProcessSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
SetRedirectStandardOutput(bool) ProcessSettings
Sets a value indicating whether the output of an application is written to the System.Diagnostics.Process.StandardOutput stream.
SetTimeout(int) ProcessSettings
Sets the optional timeout for process execution
ThrowIfNull<ProcessSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ProcessSettings>(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
UseWorkingDirectory(DirectoryPath) ProcessSettings
Sets the working directory for the process to be started.
WithArguments(Action<ProcessArgumentBuilder>) ProcessSettings
Sets the arguments for the process