Process (Fake)

Process Module

Namespace: Fake.Core
Assembly: Fake.Core.Process.dll

Contains functions which can be used to start other tools.

Types

Type	Description
ProcessList

Functions and values

Function or value	Description
`Process.AlwaysSetProcessEncoding` Full Usage: `Process.AlwaysSetProcessEncoding` Returns: `bool`	If set to true the ProcessHelper will start all processes with a custom ProcessEncoding. If set to false (default) only mono processes will be changed. Returns: `bool`
`Process.ProcessEncoding` Full Usage: `Process.ProcessEncoding` Returns: `Encoding`	The ProcessHelper will start all processes with this encoding if AlwaysSetProcessEncoding is set to true. If AlwaysSetProcessEncoding is set to false (default) only mono processes will be changed. Returns: `Encoding`
`Process.createEnvironmentMap ()` Full Usage: `Process.createEnvironmentMap ()` Parameters: () : `unit` Returns: `Map<string, string>`	() : `unit` Returns: `Map<string, string>`
`Process.defaultEnvVar` Full Usage: `Process.defaultEnvVar` Returns: `string`	Returns: `string`
`Process.disableRedirectOutput startInfo` Full Usage: `Process.disableRedirectOutput startInfo` Parameters: startInfo : `^a` Returns: `^a` Modifiers: inline Type parameters: ^a	startInfo : `^a` Returns: `^a`
`Process.disableShellExecute startInfo` Full Usage: `Process.disableShellExecute startInfo` Parameters: startInfo : `ProcStartInfo` Returns: `ProcStartInfo`	startInfo : `ProcStartInfo` Returns: `ProcStartInfo`
`Process.ensureProcessesHaveStopped name timeout` Full Usage: `Process.ensureProcessesHaveStopped name timeout` Parameters: name : `string` - The name of the processes in question. timeout : `TimeSpan` - The timespan to time out after.	Waits until the processes with the given name have stopped or fails after given timeout. name : `string` The name of the processes in question. timeout : `TimeSpan` The timespan to time out after.
`Process.getAllByName name` Full Usage: `Process.getAllByName name` Parameters: name : `string` - The process name Returns: `seq<Process>`	Returns all processes with the given name name : `string` The process name Returns: `seq<Process>`
`Process.getEnvironmentVariable envKey startInfo` Full Usage: `Process.getEnvironmentVariable envKey startInfo` Parameters: envKey : `string` startInfo : `^a` Returns: `string option` Modifiers: inline Type parameters: ^a	envKey : `string` startInfo : `^a` Returns: `string option`
`Process.getFileName p` Full Usage: `Process.getFileName p` Parameters: p : `Process` - The process instance to use Returns: `string`	Retrieve the file-path of the running executable of the given process. p : `Process` The process instance to use Returns: `string`
`Process.getRedirectOutputToTrace ()` Full Usage: `Process.getRedirectOutputToTrace ()` Parameters: () : `unit` Returns: `bool`	() : `unit` Returns: `bool`
`Process.kill proc` Full Usage: `Process.kill proc` Parameters: proc : `Process` - The process to kill	Kills the given process proc : `Process` The process to kill
`Process.killAllByName name` Full Usage: `Process.killAllByName name` Parameters: name : `string` - The process name	Kills all processes with the given name name : `string` The process name
`Process.killAllCreatedProcesses ()` Full Usage: `Process.killAllCreatedProcesses ()` Parameters: () : `unit`	Kills all processes that are created by the FAKE build script unless "donotkill" flag was set. () : `unit`
`Process.killById id` Full Usage: `Process.killById id` Parameters: id : `int` - The process id to kill	Kills all processes with the given id id : `int` The process id to kill
`Process.killFSI ()` Full Usage: `Process.killFSI ()` Parameters: () : `unit`	Kills the F# Interactive (FSI) process. () : `unit`
`Process.killMSBuild ()` Full Usage: `Process.killMSBuild ()` Parameters: () : `unit`	Kills the MSBuild process. () : `unit`
`Process.monoVersion` Full Usage: `Process.monoVersion` Returns: `(string * Version option) option`	Returns: `(string * Version option) option`
`Process.redirectOutput startInfo` Full Usage: `Process.redirectOutput startInfo` Parameters: startInfo : `^a` Returns: `^a` Modifiers: inline Type parameters: ^a	startInfo : `^a` Returns: `^a`
`Process.removeEnvironmentVariable envKey startInfo` Full Usage: `Process.removeEnvironmentVariable envKey startInfo` Parameters: envKey : `string` - The environment variable name startInfo : `^a` - The start process info Returns: `^a` Modifiers: inline Type parameters: ^a	Unsets the given environment variable for the started process envKey : `string` The environment variable name startInfo : `^a` The start process info Returns: `^a`
`Process.setCurrentEnvironmentVariables startInfo` Full Usage: `Process.setCurrentEnvironmentVariables startInfo` Parameters: startInfo : `^a` - The start process info Returns: `^a` Modifiers: inline Type parameters: ^a	Sets all current environment variables to their current values startInfo : `^a` The start process info Returns: `^a`
`Process.setEnableProcessTracing` Full Usage: `Process.setEnableProcessTracing` Returns: `bool -> unit`	Returns: `bool -> unit`
`Process.setEnvironment map startInfo` Full Usage: `Process.setEnvironment map startInfo` Parameters: map : `Map<string, string>` startInfo : `^a` Returns: `^a` Modifiers: inline Type parameters: ^a	map : `Map<string, string>` startInfo : `^a` Returns: `^a`
`Process.setEnvironmentVariable envKey envVar startInfo` Full Usage: `Process.setEnvironmentVariable envKey envVar startInfo` Parameters: envKey : `string` - The environment variable name envVar : `string` - The environment variable value startInfo : `^a` - The start process info Returns: `^a` Modifiers: inline Type parameters: ^a	Sets the given environment variable for the given startInfo. Existing values will be overriden. envKey : `string` The environment variable name envVar : `string` The environment variable value startInfo : `^a` The start process info Returns: `^a`
`Process.setEnvironmentVariables vars startInfo` Full Usage: `Process.setEnvironmentVariables vars startInfo` Parameters: vars : `seq<string * string>` - The environment variables to set startInfo : `^a` - The start process info Returns: `^a` Modifiers: inline Type parameters: ^a	Sets the given environment variables. vars : `seq<string * string>` The environment variables to set startInfo : `^a` The start process info Returns: `^a`
`Process.setKillCreatedProcesses enable` Full Usage: `Process.setKillCreatedProcesses enable` Parameters: enable : `bool`	enable : `bool`
`Process.setRedirectOutput shouldRedirect startInfo` Full Usage: `Process.setRedirectOutput shouldRedirect startInfo` Parameters: shouldRedirect : `bool` startInfo : `^a` Returns: `^a` Modifiers: inline Type parameters: ^a	shouldRedirect : `bool` startInfo : `^a` Returns: `^a`
`Process.setRedirectOutputToTrace` Full Usage: `Process.setRedirectOutputToTrace` Returns: `bool -> unit`	Returns: `bool -> unit`
`Process.shellExec args` Full Usage: `Process.shellExec args` Parameters: args : `ExecParams` - The execution arguments Returns: `int`	Execute an external program and return the exit code. args : `ExecParams` The execution arguments Returns: `int`
`Process.shouldEnableProcessTracing ()` Full Usage: `Process.shouldEnableProcessTracing ()` Parameters: () : `unit` Returns: `bool`	() : `unit` Returns: `bool`
`Process.shouldKillCreatedProcesses ()` Full Usage: `Process.shouldKillCreatedProcesses ()` Parameters: () : `unit` Returns: `bool`	() : `unit` Returns: `bool`
`Process.withFramework proc` Full Usage: `Process.withFramework proc` Parameters: proc : `ProcStartInfo` - The process start info Returns: `ProcStartInfo`	Ensures the executable is run with the full framework. On non-windows platforms that means running the tool by invoking 'mono'. proc : `ProcStartInfo` The process start info Returns: `ProcStartInfo`